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 d3db935
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: .speakeasy/in.openapi.yaml
+16-16Lines changed: 16 additions & 16 deletions
Original file line number
Diff line number
Diff line change
@@ -10670,7 +10670,7 @@ components:
10670
10670
reset_interval:
10671
10671
$ref: '#/components/schemas/GuardrailInterval'
10672
10672
workspace_id:
10673
-
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.'
10673
+
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.'
10674
10674
example: '0df9e665-d932-5740-b2c7-b52af166bc11'
10675
10675
format: 'uuid'
10676
10676
type: 'string'
@@ -45632,7 +45632,7 @@ paths:
45632
45632
x-speakeasy-name-override: 'submitFeedback'
45633
45633
/guardrails:
45634
45634
get:
45635
-
description: 'List all guardrails for the authenticated user. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
45635
+
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.'
45636
45636
operationId: 'listGuardrails'
45637
45637
parameters:
45638
45638
- description: 'Number of records to skip for pagination'
@@ -45658,12 +45658,12 @@ paths:
45658
45658
maximum: 100
45659
45659
minimum: 1
45660
45660
type: 'integer'
45661
-
- description: 'Filter guardrails by workspace ID. By default, guardrails in the default workspace are returned.'
45661
+
- 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.'
45662
45662
in: 'query'
45663
45663
name: 'workspace_id'
45664
45664
required: false
45665
45665
schema:
45666
-
description: 'Filter guardrails by workspace ID. By default, guardrails in the default workspace are returned.'
45666
+
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.'
45667
45667
example: '0df9e665-d932-5740-b2c7-b52af166bc11'
45668
45668
format: 'uuid'
45669
45669
type: 'string'
@@ -45750,7 +45750,7 @@ paths:
45750
45750
results: '$.data'
45751
45751
type: 'offsetLimit'
45752
45752
post:
45753
-
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.'
45753
+
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.'
45754
45754
operationId: 'createGuardrail'
45755
45755
requestBody:
45756
45756
content:
@@ -45854,7 +45854,7 @@ paths:
45854
45854
x-speakeasy-name-override: 'create'
45855
45855
/guardrails/{id}:
45856
45856
delete:
45857
-
description: 'Delete an existing guardrail. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
45857
+
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.'
45858
45858
operationId: 'deleteGuardrail'
45859
45859
parameters:
45860
45860
- description: 'The unique identifier of the guardrail to delete'
@@ -45920,7 +45920,7 @@ paths:
45920
45920
- 'Guardrails'
45921
45921
x-speakeasy-name-override: 'delete'
45922
45922
get:
45923
-
description: 'Get a single guardrail by ID. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
45923
+
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.'
45924
45924
operationId: 'getGuardrail'
45925
45925
parameters:
45926
45926
- description: 'The unique identifier of the guardrail to retrieve'
@@ -46003,7 +46003,7 @@ paths:
46003
46003
- 'Guardrails'
46004
46004
x-speakeasy-name-override: 'get'
46005
46005
patch:
46006
-
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.'
46006
+
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.'
46007
46007
operationId: 'updateGuardrail'
46008
46008
parameters:
46009
46009
- description: 'The unique identifier of the guardrail to update'
@@ -46121,7 +46121,7 @@ paths:
46121
46121
x-speakeasy-name-override: 'update'
46122
46122
/guardrails/{id}/assignments/keys:
46123
46123
get:
46124
-
description: 'List all API key assignments for a specific guardrail. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
46124
+
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.'
46125
46125
operationId: 'listGuardrailKeyAssignments'
46126
46126
parameters:
46127
46127
- description: 'The unique identifier of the guardrail'
@@ -46229,7 +46229,7 @@ paths:
46229
46229
results: '$.data'
46230
46230
type: 'offsetLimit'
46231
46231
post:
46232
-
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.'
46232
+
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.'
46233
46233
operationId: 'bulkAssignKeysToGuardrail'
46234
46234
parameters:
46235
46235
- description: 'The unique identifier of the guardrail'
@@ -46315,7 +46315,7 @@ paths:
46315
46315
x-speakeasy-name-override: 'bulkAssignKeys'
46316
46316
/guardrails/{id}/assignments/keys/remove:
46317
46317
post:
46318
-
description: 'Unassign multiple API keys from a specific guardrail. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
46318
+
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.'
46319
46319
operationId: 'bulkUnassignKeysFromGuardrail'
46320
46320
parameters:
46321
46321
- description: 'The unique identifier of the guardrail'
@@ -46401,7 +46401,7 @@ paths:
46401
46401
x-speakeasy-name-override: 'bulkUnassignKeys'
46402
46402
/guardrails/{id}/assignments/members:
46403
46403
get:
46404
-
description: 'List all organization member assignments for a specific guardrail. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
46404
+
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.'
46405
46405
operationId: 'listGuardrailMemberAssignments'
46406
46406
parameters:
46407
46407
- description: 'The unique identifier of the guardrail'
@@ -46508,7 +46508,7 @@ paths:
46508
46508
results: '$.data'
46509
46509
type: 'offsetLimit'
46510
46510
post:
46511
-
description: 'Assign multiple organization members to a specific guardrail. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
46511
+
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.'
46512
46512
operationId: 'bulkAssignMembersToGuardrail'
46513
46513
parameters:
46514
46514
- description: 'The unique identifier of the guardrail'
@@ -46595,7 +46595,7 @@ paths:
46595
46595
x-speakeasy-name-override: 'bulkAssignMembers'
46596
46596
/guardrails/{id}/assignments/members/remove:
46597
46597
post:
46598
-
description: 'Unassign multiple organization members from a specific guardrail. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
46598
+
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.'
46599
46599
operationId: 'bulkUnassignMembersFromGuardrail'
46600
46600
parameters:
46601
46601
- description: 'The unique identifier of the guardrail'
@@ -46682,7 +46682,7 @@ paths:
46682
46682
x-speakeasy-name-override: 'bulkUnassignMembers'
46683
46683
/guardrails/assignments/keys:
46684
46684
get:
46685
-
description: 'List all API key guardrail assignments for the authenticated user. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
46685
+
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.'
46686
46686
operationId: 'listKeyAssignments'
46687
46687
parameters:
46688
46688
- description: 'Number of records to skip for pagination'
@@ -46792,7 +46792,7 @@ paths:
46792
46792
type: 'offsetLimit'
46793
46793
/guardrails/assignments/members:
46794
46794
get:
46795
-
description: 'List all organization member guardrail assignments for the authenticated user. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
46795
+
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.'
46796
46796
operationId: 'listMemberAssignments'
46797
46797
parameters:
46798
46798
- description: 'Number of records to skip for pagination'
0 commit comments