Skip to content

Commit fcc018e

Browse files
openrouter-docs-sync[bot]OpenRouter SDK Bot
andauthored
chore: update OpenAPI spec from monorepo (#1285)
Co-authored-by: OpenRouter SDK Bot <sdk-bot@openrouter.ai>
1 parent 2225ca0 commit fcc018e

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

‎.speakeasy/in.openapi.yaml‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7231,7 +7231,7 @@ components:
72317231
workspace_id: '550e8400-e29b-41d4-a716-446655440000'
72327232
properties:
72337233
allowed_api_key_hashes:
7234-
description: 'Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) that may use this credential. `null` means no restriction.'
7234+
description: 'Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) that may use this credential. `null` means no restriction. A workspace-scoped management key can only name API keys in its own workspace.'
72357235
example:
72367236
- 'f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943'
72377237
items:
@@ -10297,7 +10297,7 @@ components:
1029710297
provider: 'openai'
1029810298
properties:
1029910299
allowed_api_key_hashes:
10300-
description: 'Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) that may use this credential. `null` means no restriction. Must contain at least one hash if provided. Hashes that do not belong to your account return a 400.'
10300+
description: 'Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) that may use this credential. `null` means no restriction. Must contain at least one hash if provided. Hashes that do not belong to your account return a 400; for a workspace-scoped management key, so do hashes of API keys outside its own workspace.'
1030110301
example:
1030210302
- 'f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943'
1030310303
items:
@@ -10374,7 +10374,7 @@ components:
1037410374
provider:
1037510375
$ref: '#/components/schemas/BYOKProviderSlug'
1037610376
workspace_id:
10377-
description: 'Optional workspace ID to scope the credential to. When omitted, the credential is created in the account''s default workspace; if that default has been deleted, the request returns a 400 and you must pass `workspace_id` explicitly.'
10377+
description: 'Optional workspace ID to scope the credential to. When omitted, a workspace-scoped management key creates it in its own workspace. An organization management key creates it in the account''s default workspace; if that default has been deleted, the request returns a 400 and you must pass `workspace_id` explicitly.'
1037810378
example: '550e8400-e29b-41d4-a716-446655440000'
1037910379
format: 'uuid'
1038010380
type: 'string'
@@ -36093,7 +36093,7 @@ components:
3609336093
name: 'Updated OpenAI Key'
3609436094
properties:
3609536095
allowed_api_key_hashes:
36096-
description: 'Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) that may use this credential. `null` clears the restriction. Must contain at least one hash if provided. Hashes that do not belong to your account return a 400.'
36096+
description: 'Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) that may use this credential. `null` clears the restriction. Must contain at least one hash if provided. Hashes that do not belong to your account return a 400; for a workspace-scoped management key, so do hashes of API keys outside its own workspace.'
3609736097
example:
3609836098
- 'f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943'
3609936099
items:
@@ -41199,7 +41199,7 @@ paths:
4119941199
- 'Benchmarks'
4120041200
/byok:
4120141201
get:
41202-
description: '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](/docs/guides/overview/auth/management-api-keys) required.'
41202+
description: 'List the bring-your-own-key (BYOK) provider credentials for the authenticated entity''s default workspace, or a workspace-scoped management key''s own 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. A workspace-scoped management key can only list its own workspace; any other `workspace_id` returns 403. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
4120341203
operationId: 'listBYOKKeys'
4120441204
parameters:
4120541205
- description: 'Number of records to skip for pagination'
@@ -41225,12 +41225,12 @@ paths:
4122541225
maximum: 100
4122641226
minimum: 1
4122741227
type: 'integer'
41228-
- description: 'Optional workspace ID to filter by. When omitted, resolves to the account’s default workspace; if that default has been deleted, the request returns a 400 and you must pass `workspace_id` explicitly.'
41228+
- description: 'Optional workspace ID to filter by. When omitted, a workspace-scoped management key uses its own workspace. An organization management key uses the account’s default workspace; if that default has been deleted, the request returns a 400 and you must pass `workspace_id` explicitly.'
4122941229
in: 'query'
4123041230
name: 'workspace_id'
4123141231
required: false
4123241232
schema:
41233-
description: 'Optional workspace ID to filter by. When omitted, resolves to the account’s default workspace; if that default has been deleted, the request returns a 400 and you must pass `workspace_id` explicitly.'
41233+
description: 'Optional workspace ID to filter by. When omitted, a workspace-scoped management key uses its own workspace. An organization management key uses the account’s default workspace; if that default has been deleted, the request returns a 400 and you must pass `workspace_id` explicitly.'
4123441234
example: '550e8400-e29b-41d4-a716-446655440000'
4123541235
format: 'uuid'
4123641236
type: 'string'
@@ -41449,7 +41449,7 @@ paths:
4144941449
results: '$.data'
4145041450
type: 'offsetLimit'
4145141451
post:
41452-
description: 'Create a new bring-your-own-key (BYOK) provider credential. The raw key is encrypted at rest and never returned in API responses. When `workspace_id` is omitted, the credential is created in the default workspace; if that default has been deleted, the request returns a 400 and you must pass `workspace_id` explicitly. Treat the raw key as write-only; it is never returned after creation. Use `allowed_api_key_hashes` to restrict the credential to specific OpenRouter API keys. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
41452+
description: 'Create a new bring-your-own-key (BYOK) provider credential. The raw key is encrypted at rest and never returned in API responses. When `workspace_id` is omitted, the credential is created in the default workspace; if that default has been deleted, the request returns a 400 and you must pass `workspace_id` explicitly. A workspace-scoped management key creates the credential in its own workspace when `workspace_id` is omitted, and any other `workspace_id` returns 403. Treat the raw key as write-only; it is never returned after creation. Use `allowed_api_key_hashes` to restrict the credential to specific OpenRouter API keys. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
4145341453
operationId: 'createBYOKKey'
4145441454
requestBody:
4145541455
content:
@@ -41532,7 +41532,7 @@ paths:
4153241532
x-speakeasy-name-override: 'create'
4153341533
/byok/{id}:
4153441534
delete:
41535-
description: '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](/docs/guides/overview/auth/management-api-keys) required.'
41535+
description: '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. A workspace-scoped management key only reaches credentials in its own workspace; any other `id` returns 404. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
4153641536
operationId: 'deleteBYOKKey'
4153741537
parameters:
4153841538
- description: 'The BYOK credential ID (UUID).'
@@ -41598,7 +41598,7 @@ paths:
4159841598
- 'BYOK'
4159941599
x-speakeasy-name-override: 'delete'
4160041600
get:
41601-
description: 'Get a single bring-your-own-key (BYOK) provider credential by its `id`. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
41601+
description: 'Get a single bring-your-own-key (BYOK) provider credential by its `id`. A workspace-scoped management key only reaches credentials in its own workspace; any other `id` returns 404. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
4160241602
operationId: 'getBYOKKey'
4160341603
parameters:
4160441604
- description: 'The BYOK credential ID (UUID).'
@@ -41680,7 +41680,7 @@ paths:
4168041680
- 'BYOK'
4168141681
x-speakeasy-name-override: 'get'
4168241682
patch:
41683-
description: '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). Use `allowed_api_key_hashes` to restrict the credential to specific OpenRouter API keys (`null` clears the restriction). [Management key](/docs/guides/overview/auth/management-api-keys) required.'
41683+
description: '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). Use `allowed_api_key_hashes` to restrict the credential to specific OpenRouter API keys (`null` clears the restriction). A workspace-scoped management key only reaches credentials in its own workspace; any other `id` returns 404. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
4168441684
operationId: 'updateBYOKKey'
4168541685
parameters:
4168641686
- description: 'The BYOK credential ID (UUID).'

0 commit comments

Comments
 (0)