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 a55b4fe
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: .speakeasy/out.openapi.yaml
+16-16Lines changed: 16 additions & 16 deletions
Original file line number
Diff line number
Diff line change
@@ -10765,7 +10765,7 @@ components:
10765
10765
reset_interval:
10766
10766
$ref: '#/components/schemas/GuardrailInterval'
10767
10767
workspace_id:
10768
-
description: 'The workspace to create the guardrail in. When omitted, the guardrail is created in the default workspace; if that default has been deleted, the request returns a 400 and you must pass `workspace_id` explicitly. This only places the guardrail in the workspace; the created guardrail enforces nothing for that workspace''s traffic until it is assigned to API keys or members. To restrict all traffic in a workspace, update the workspace''s default guardrail instead.'
10768
+
description: 'The workspace to create the guardrail in. When omitted, an organization management key creates the guardrail in the default workspace (a 400 if that default has been deleted, so pass `workspace_id` explicitly) and a workspace-scoped key creates it in its own workspace. A workspace-scoped key gets a 403 for any other workspace. This only places the guardrail in the workspace; the created guardrail enforces nothing for that workspace''s traffic until it is assigned to API keys or members. To restrict all traffic in a workspace, update the workspace''s default guardrail instead.'
10769
10769
example: '0df9e665-d932-5740-b2c7-b52af166bc11'
10770
10770
format: 'uuid'
10771
10771
type: 'string'
@@ -46140,7 +46140,7 @@ paths:
46140
46140
- $ref: "#/components/parameters/AppCategories"
46141
46141
/guardrails:
46142
46142
get:
46143
-
description: 'List all guardrails for the authenticated user. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
46143
+
description: 'List all guardrails for the authenticated user. A workspace-scoped management key lists only its own workspace, which `workspace_id` defaults to; naming another workspace returns 403. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
46144
46144
operationId: 'listGuardrails'
46145
46145
parameters:
46146
46146
- description: 'Number of records to skip for pagination'
@@ -46167,12 +46167,12 @@ paths:
46167
46167
maximum: 100
46168
46168
minimum: 1
46169
46169
type: 'integer'
46170
-
- description: 'Filter guardrails by workspace ID. By default, guardrails in the default workspace are returned.'
46170
+
- description: 'Filter guardrails by workspace ID. When omitted, an organization management key gets guardrails in the default workspace and a workspace-scoped key gets guardrails in its own workspace. A workspace-scoped key gets 403 for any other workspace.'
46171
46171
in: 'query'
46172
46172
name: 'workspace_id'
46173
46173
required: false
46174
46174
schema:
46175
-
description: 'Filter guardrails by workspace ID. By default, guardrails in the default workspace are returned.'
46175
+
description: 'Filter guardrails by workspace ID. When omitted, an organization management key gets guardrails in the default workspace and a workspace-scoped key gets guardrails in its own workspace. A workspace-scoped key gets 403 for any other workspace.'
46176
46176
example: '0df9e665-d932-5740-b2c7-b52af166bc11'
46177
46177
format: 'uuid'
46178
46178
type: 'string'
@@ -46259,7 +46259,7 @@ paths:
46259
46259
results: '$.data'
46260
46260
type: 'offsetLimit'
46261
46261
post:
46262
-
description: 'Create a new guardrail for the authenticated user. A newly created guardrail enforces nothing until it is assigned to API keys or organization members; `workspace_id` places the guardrail in a workspace but does not apply it to that workspace''s traffic. To restrict all traffic in a workspace, update the workspace''s default guardrail instead. Set `allowed_data_regions` to enforce [In-Region Routing](/docs/guides/features/in-region-routing#enforcing-in-region-routing-with-guardrails): governed requests must arrive through one of the listed OpenRouter domains and are rejected with a 403 otherwise. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
46262
+
description: 'Create a new guardrail for the authenticated user. A newly created guardrail enforces nothing until it is assigned to API keys or organization members; `workspace_id` places the guardrail in a workspace but does not apply it to that workspace''s traffic. To restrict all traffic in a workspace, update the workspace''s default guardrail instead. Set `allowed_data_regions` to enforce [In-Region Routing](/docs/guides/features/in-region-routing#enforcing-in-region-routing-with-guardrails): governed requests must arrive through one of the listed OpenRouter domains and are rejected with a 403 otherwise. A workspace-scoped management key creates in its own workspace, which `workspace_id` defaults to; naming another workspace returns 403. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
46263
46263
operationId: 'createGuardrail'
46264
46264
requestBody:
46265
46265
content:
@@ -46367,7 +46367,7 @@ paths:
46367
46367
- $ref: "#/components/parameters/AppCategories"
46368
46368
/guardrails/{id}:
46369
46369
delete:
46370
-
description: 'Delete an existing guardrail. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
46370
+
description: 'Delete an existing guardrail. A workspace-scoped management key reaches only guardrails in its own workspace; any other guardrail returns 404. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
46371
46371
operationId: 'deleteGuardrail'
46372
46372
parameters:
46373
46373
- description: 'The unique identifier of the guardrail to delete'
@@ -46433,7 +46433,7 @@ paths:
46433
46433
- 'Guardrails'
46434
46434
x-speakeasy-name-override: 'delete'
46435
46435
get:
46436
-
description: 'Get a single guardrail by ID. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
46436
+
description: 'Get a single guardrail by ID. A workspace-scoped management key reaches only guardrails in its own workspace; any other guardrail returns 404. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
46437
46437
operationId: 'getGuardrail'
46438
46438
parameters:
46439
46439
- description: 'The unique identifier of the guardrail to retrieve'
@@ -46516,7 +46516,7 @@ paths:
46516
46516
- 'Guardrails'
46517
46517
x-speakeasy-name-override: 'get'
46518
46518
patch:
46519
-
description: 'Update an existing guardrail, or materialize an unconfigured workspace default guardrail. Collection fields use replace semantics: send the full desired set on every update. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
46519
+
description: 'Update an existing guardrail, or materialize an unconfigured workspace default guardrail. Collection fields use replace semantics: send the full desired set on every update. A workspace-scoped management key reaches only guardrails in its own workspace; any other guardrail returns 404. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
46520
46520
operationId: 'updateGuardrail'
46521
46521
parameters:
46522
46522
- description: 'The unique identifier of the guardrail to update'
@@ -46638,7 +46638,7 @@ paths:
46638
46638
- $ref: "#/components/parameters/AppCategories"
46639
46639
/guardrails/{id}/assignments/keys:
46640
46640
get:
46641
-
description: 'List all API key assignments for a specific guardrail. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
46641
+
description: 'List all API key assignments for a specific guardrail. A workspace-scoped management key reaches only guardrails in its own workspace; any other guardrail returns 404. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
46642
46642
operationId: 'listGuardrailKeyAssignments'
46643
46643
parameters:
46644
46644
- description: 'The unique identifier of the guardrail'
@@ -46747,7 +46747,7 @@ paths:
46747
46747
results: '$.data'
46748
46748
type: 'offsetLimit'
46749
46749
post:
46750
-
description: 'Assign multiple API keys to a specific guardrail. A key may hold at most one guardrail; assigning replaces any existing assignment. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
46750
+
description: 'Assign multiple API keys to a specific guardrail. A key may hold at most one guardrail; assigning replaces any existing assignment. A workspace-scoped management key reaches only guardrails in its own workspace (any other returns 404), and a batch naming an unknown or out-of-workspace key hash is rejected with 400 before anything changes. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
46751
46751
operationId: 'bulkAssignKeysToGuardrail'
46752
46752
parameters:
46753
46753
- description: 'The unique identifier of the guardrail'
@@ -46837,7 +46837,7 @@ paths:
46837
46837
- $ref: "#/components/parameters/AppCategories"
46838
46838
/guardrails/{id}/assignments/keys/remove:
46839
46839
post:
46840
-
description: 'Unassign multiple API keys from a specific guardrail. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
46840
+
description: 'Unassign multiple API keys from a specific guardrail. A workspace-scoped management key reaches only guardrails in its own workspace (any other returns 404), and a batch naming an unknown or out-of-workspace key hash is rejected with 400 before anything changes. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
46841
46841
operationId: 'bulkUnassignKeysFromGuardrail'
46842
46842
parameters:
46843
46843
- description: 'The unique identifier of the guardrail'
@@ -46927,7 +46927,7 @@ paths:
46927
46927
- $ref: "#/components/parameters/AppCategories"
46928
46928
/guardrails/{id}/assignments/members:
46929
46929
get:
46930
-
description: 'List all organization member assignments for a specific guardrail. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
46930
+
description: 'List all organization member assignments for a specific guardrail. A workspace-scoped management key reaches only guardrails in its own workspace; any other guardrail returns 404. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
46931
46931
operationId: 'listGuardrailMemberAssignments'
46932
46932
parameters:
46933
46933
- description: 'The unique identifier of the guardrail'
@@ -47035,7 +47035,7 @@ paths:
47035
47035
results: '$.data'
47036
47036
type: 'offsetLimit'
47037
47037
post:
47038
-
description: 'Assign multiple organization members to a specific guardrail. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
47038
+
description: 'Assign multiple organization members to a specific guardrail. Requires an organization-scoped management key; workspace-scoped management keys return 403. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
47039
47039
operationId: 'bulkAssignMembersToGuardrail'
47040
47040
parameters:
47041
47041
- description: 'The unique identifier of the guardrail'
@@ -47126,7 +47126,7 @@ paths:
47126
47126
- $ref: "#/components/parameters/AppCategories"
47127
47127
/guardrails/{id}/assignments/members/remove:
47128
47128
post:
47129
-
description: 'Unassign multiple organization members from a specific guardrail. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
47129
+
description: 'Unassign multiple organization members from a specific guardrail. Requires an organization-scoped management key; workspace-scoped management keys return 403. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
47130
47130
operationId: 'bulkUnassignMembersFromGuardrail'
47131
47131
parameters:
47132
47132
- description: 'The unique identifier of the guardrail'
@@ -47217,7 +47217,7 @@ paths:
47217
47217
- $ref: "#/components/parameters/AppCategories"
47218
47218
/guardrails/assignments/keys:
47219
47219
get:
47220
-
description: 'List all API key guardrail assignments for the authenticated user. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
47220
+
description: 'List all API key guardrail assignments for the authenticated user. A workspace-scoped management key lists only its own workspace, which `workspace_id` defaults to; naming another workspace returns 403. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
47221
47221
operationId: 'listKeyAssignments'
47222
47222
parameters:
47223
47223
- description: 'Number of records to skip for pagination'
@@ -47332,7 +47332,7 @@ paths:
47332
47332
- $ref: "#/components/parameters/AppCategories"
47333
47333
/guardrails/assignments/members:
47334
47334
get:
47335
-
description: 'List all organization member guardrail assignments for the authenticated user. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
47335
+
description: 'List all organization member guardrail assignments for the authenticated user. A workspace-scoped management key lists only its own workspace, which `workspace_id` defaults to; naming another workspace returns 403. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
47336
47336
operationId: 'listMemberAssignments'
47337
47337
parameters:
47338
47338
- description: 'Number of records to skip for pagination'
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
![speakeasy-github[bot]](https://avatars.githubusercontent.com/in/308252?v=4&size=40){kind=avatar}
0 commit comments