You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit fcc018e
Browse filesBrowse the repository at this point in the historyBrowse files
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.'
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.'
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.'
10378
10378
example: '550e8400-e29b-41d4-a716-446655440000'
10379
10379
format: 'uuid'
10380
10380
type: 'string'
@@ -36093,7 +36093,7 @@ components:
36093
36093
name: 'Updated OpenAI Key'
36094
36094
properties:
36095
36095
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.'
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.'
41203
41203
operationId: 'listBYOKKeys'
41204
41204
parameters:
41205
41205
- description: 'Number of records to skip for pagination'
@@ -41225,12 +41225,12 @@ paths:
41225
41225
maximum: 100
41226
41226
minimum: 1
41227
41227
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.'
41229
41229
in: 'query'
41230
41230
name: 'workspace_id'
41231
41231
required: false
41232
41232
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.'
41234
41234
example: '550e8400-e29b-41d4-a716-446655440000'
41235
41235
format: 'uuid'
41236
41236
type: 'string'
@@ -41449,7 +41449,7 @@ paths:
41449
41449
results: '$.data'
41450
41450
type: 'offsetLimit'
41451
41451
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.'
41453
41453
operationId: 'createBYOKKey'
41454
41454
requestBody:
41455
41455
content:
@@ -41532,7 +41532,7 @@ paths:
41532
41532
x-speakeasy-name-override: 'create'
41533
41533
/byok/{id}:
41534
41534
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.'
41536
41536
operationId: 'deleteBYOKKey'
41537
41537
parameters:
41538
41538
- description: 'The BYOK credential ID (UUID).'
@@ -41598,7 +41598,7 @@ paths:
41598
41598
- 'BYOK'
41599
41599
x-speakeasy-name-override: 'delete'
41600
41600
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.'
41602
41602
operationId: 'getBYOKKey'
41603
41603
parameters:
41604
41604
- description: 'The BYOK credential ID (UUID).'
@@ -41680,7 +41680,7 @@ paths:
41680
41680
- 'BYOK'
41681
41681
x-speakeasy-name-override: 'get'
41682
41682
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.'
0 commit comments