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 1501180
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: .speakeasy/in.openapi.yaml
+47-23Lines changed: 47 additions & 23 deletions
Original file line number
Diff line number
Diff line change
@@ -10856,7 +10856,7 @@ components:
10856
10856
type: 'langfuse'
10857
10857
properties:
10858
10858
api_key_hashes:
10859
-
description: '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.'
10859
+
description: '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. A workspace-scoped management key can only name API keys in its own workspace; any other hash returns 400.'
10860
10860
example: null
10861
10861
items:
10862
10862
type: 'string'
@@ -10946,7 +10946,7 @@ components:
10946
10946
example: 'langfuse'
10947
10947
type: 'string'
10948
10948
workspace_id:
10949
-
description: 'Optional workspace ID. Defaults to the authenticated entity''s default workspace.'
10949
+
description: 'Optional workspace ID. Defaults to the authenticated entity''s default workspace, or a workspace-scoped management key''s own workspace.'
10950
10950
example: '550e8400-e29b-41d4-a716-446655440000'
10951
10951
format: 'uuid'
10952
10952
type: 'string'
@@ -12604,7 +12604,7 @@ components:
12604
12604
type: 'object'
12605
12605
ExtractionAsset:
12606
12606
additionalProperties: false
12607
-
description: 'An image or PDF sent once and referenced by its key in the `assets` map. `data_base64` is the file in standard base64 with no `data:` prefix. PDF is read by document models only.'
12607
+
description: 'An image or PDF sent once and referenced by its key in the `assets` map. `data_base64` is the file in standard base64 with no `data:` prefix. Which formats are read is model-specific: a format the model cannot read fails with a 400.'
12608
12608
properties:
12609
12609
data_base64:
12610
12610
minLength: 1
@@ -12615,6 +12615,7 @@ components:
12615
12615
- 'png'
12616
12616
- 'jpg'
12617
12617
- 'jpeg'
12618
+
- 'webp'
12618
12619
- 'pdf'
12619
12620
type: 'string'
12620
12621
type:
@@ -12646,7 +12647,7 @@ components:
12646
12647
- 'document'
12647
12648
type: 'string'
12648
12649
span:
12649
-
description: 'Unicode code point offsets [start, end) into the state text: index code points (not UTF-16 code units or UTF-8 bytes), so an emoji or accented letter counts once.'
12650
+
description: 'Unicode code point offsets [start, end) into the state text: index code points (not UTF-16 code units or UTF-8 bytes), so an emoji or accented letter counts once. Absent for an answer that has no offsets in the state text, for example a null answer, one read from an image or a document, or one the provider returned without offsets that delimit it.'
12650
12651
items:
12651
12652
type: 'integer'
12652
12653
maxItems: 2
@@ -12684,6 +12685,9 @@ components:
12684
12685
enum:
12685
12686
- 'date'
12686
12687
type: 'string'
12688
+
unit:
12689
+
description: 'Unit label for the value.'
12690
+
type: 'string'
12687
12691
required:
12688
12692
- 'type'
12689
12693
type: 'object'
@@ -12707,7 +12711,7 @@ components:
12707
12711
- 'document'
12708
12712
type: 'string'
12709
12713
span:
12710
-
description: 'Unicode code point offsets [start, end) into the state text: index code points (not UTF-16 code units or UTF-8 bytes), so an emoji or accented letter counts once.'
12714
+
description: 'Unicode code point offsets [start, end) into the state text: index code points (not UTF-16 code units or UTF-8 bytes), so an emoji or accented letter counts once. Absent for an answer that has no offsets in the state text, for example a null answer, one read from an image or a document, or one the provider returned without offsets that delimit it.'
12711
12715
items:
12712
12716
type: 'integer'
12713
12717
maxItems: 2
@@ -12745,6 +12749,9 @@ components:
12745
12749
enum:
12746
12750
- 'datetime'
12747
12751
type: 'string'
12752
+
unit:
12753
+
description: 'Unit label for the value.'
12754
+
type: 'string'
12748
12755
required:
12749
12756
- 'type'
12750
12757
type: 'object'
@@ -12769,7 +12776,7 @@ components:
12769
12776
- 'document'
12770
12777
type: 'string'
12771
12778
span:
12772
-
description: 'Unicode code point offsets [start, end) into the state text: index code points (not UTF-16 code units or UTF-8 bytes), so an emoji or accented letter counts once.'
12779
+
description: 'Unicode code point offsets [start, end) into the state text: index code points (not UTF-16 code units or UTF-8 bytes), so an emoji or accented letter counts once. Absent for an answer that has no offsets in the state text, for example a null answer, one read from an image or a document, or one the provider returned without offsets that delimit it.'
12773
12780
items:
12774
12781
type: 'integer'
12775
12782
maxItems: 2
@@ -12807,6 +12814,7 @@ components:
12807
12814
description: 'What the field should contain.'
12808
12815
type: 'string'
12809
12816
integer:
12817
+
description: 'Whole numbers only.'
12810
12818
type: 'boolean'
12811
12819
null_threshold:
12812
12820
description: 'Probability of null above which `value` is null. Default 0.5.'
@@ -12917,7 +12925,7 @@ components:
12917
12925
type: 'number'
12918
12926
- type: 'string'
12919
12927
null_threshold:
12920
-
description: 'Probability of null above which `value` is null. Default 0.5.'
12928
+
description: 'Not read on this field type: no model takes a null threshold here, and a request that sets it fails with a 400.'
12921
12929
format: 'double'
12922
12930
maximum: 1
12923
12931
minimum: 0
@@ -12943,6 +12951,7 @@ components:
12943
12951
- 'estimate'
12944
12952
type: 'string'
12945
12953
unit:
12954
+
description: 'Unit label for the value.'
12946
12955
type: 'string'
12947
12956
required:
12948
12957
- 'type'
@@ -13059,7 +13068,7 @@ components:
13059
13068
type: 'number'
13060
13069
- type: 'string'
13061
13070
null_threshold:
13062
-
description: 'Probability of null above which `value` is null. Default 0.5.'
13071
+
description: 'Not read on this field type: no model takes a null threshold here, and a request that sets it fails with a 400.'
13063
13072
format: 'double'
13064
13073
maximum: 1
13065
13074
minimum: 0
@@ -13085,6 +13094,7 @@ components:
13085
13094
- 'forecast'
13086
13095
type: 'string'
13087
13096
unit:
13097
+
description: 'Unit label for the value.'
13088
13098
type: 'string'
13089
13099
required:
13090
13100
- 'type'
@@ -13171,7 +13181,7 @@ components:
13171
13181
- 'document'
13172
13182
type: 'string'
13173
13183
spans:
13174
-
description: 'One span per item of `value`, in the same order; null for an item that has no offsets in the state text (read from an image or a document).'
13184
+
description: 'One span per item of `value`, in the same order; null for an item that has no offsets in the state text: one read from an image or a document, or one the provider returned without offsets that delimit it.'
13175
13185
items:
13176
13186
description: 'Unicode code point offsets [start, end) into the state text: index code points (not UTF-16 code units or UTF-8 bytes), so an emoji or accented letter counts once.'
13177
13187
items:
@@ -13214,6 +13224,9 @@ components:
13214
13224
instructions:
13215
13225
description: 'What the field should contain.'
13216
13226
type: 'string'
13227
+
integer:
13228
+
description: 'Whole numbers only. Lists of numbers only.'
13229
+
type: 'boolean'
13217
13230
items:
13218
13231
enum:
13219
13232
- 'text'
@@ -13230,6 +13243,9 @@ components:
13230
13243
enum:
13231
13244
- 'list'
13232
13245
type: 'string'
13246
+
unit:
13247
+
description: 'Unit label for the value.'
13248
+
type: 'string'
13233
13249
required:
13234
13250
- 'type'
13235
13251
- 'items'
@@ -13255,7 +13271,7 @@ components:
13255
13271
- 'document'
13256
13272
type: 'string'
13257
13273
span:
13258
-
description: 'Unicode code point offsets [start, end) into the state text: index code points (not UTF-16 code units or UTF-8 bytes), so an emoji or accented letter counts once.'
13274
+
description: 'Unicode code point offsets [start, end) into the state text: index code points (not UTF-16 code units or UTF-8 bytes), so an emoji or accented letter counts once. Absent for an answer that has no offsets in the state text, for example a null answer, one read from an image or a document, or one the provider returned without offsets that delimit it.'
13259
13275
items:
13260
13276
type: 'integer'
13261
13277
maxItems: 2
@@ -13290,6 +13306,7 @@ components:
13290
13306
description: 'What the field should contain.'
13291
13307
type: 'string'
13292
13308
integer:
13309
+
description: 'Whole numbers only.'
13293
13310
type: 'boolean'
13294
13311
null_threshold:
13295
13312
description: 'Probability of null above which `value` is null. Default 0.5.'
@@ -13302,6 +13319,7 @@ components:
13302
13319
- 'number'
13303
13320
type: 'string'
13304
13321
unit:
13322
+
description: 'Unit label for the value.'
13305
13323
type: 'string'
13306
13324
required:
13307
13325
- 'type'
@@ -13332,7 +13350,7 @@ components:
13332
13350
assets:
13333
13351
additionalProperties:
13334
13352
$ref: '#/components/schemas/ExtractionAsset'
13335
-
description: 'Assets keyed by reference string. Write a reference wherever the asset belongs in `state` or a field `instructions`; every asset must be referenced at least once. A `state` that is exactly the sole asset''s key carries no text of its own and is read as file-only. A model that reads either text or a document per request, not both (ScaleDown Extract with a PDF), needs that form: any other text around the key is state text and is rejected with 400.'
13353
+
description: 'Assets keyed by reference string. Write a reference wherever the asset belongs in `state` or a field `instructions`; every asset must be referenced at least once, unless `state` is empty or omitted, in which case the assets are read without a reference. A `state` that is exactly the sole asset''s key carries no text of its own and is read as file-only. A model that reads either text or a document per request, not both (ScaleDown Extract with a PDF), takes that form or an empty or omitted `state`: any other text around the key is state text and is rejected with 400.'
13336
13354
type: 'object'
13337
13355
fields:
13338
13356
additionalProperties:
@@ -13377,7 +13395,8 @@ components:
13377
13395
maxLength: 256
13378
13396
type: 'string'
13379
13397
state:
13380
-
description: 'The text to read from. May be empty only when the request carries image assets.'
13398
+
default: ''
13399
+
description: 'The text to read from. May be empty or omitted only when the request carries assets, which are then read without being referenced by key.'
13381
13400
type: 'string'
13382
13401
trace:
13383
13402
$ref: '#/components/schemas/TraceConfig'
@@ -13386,7 +13405,6 @@ components:
13386
13405
type: 'string'
13387
13406
required:
13388
13407
- 'model'
13389
-
- 'state'
13390
13408
- 'fields'
13391
13409
type: 'object'
13392
13410
ExtractionsResponse:
@@ -13480,7 +13498,7 @@ components:
13480
13498
- 'document'
13481
13499
type: 'string'
13482
13500
span:
13483
-
description: 'Unicode code point offsets [start, end) into the state text: index code points (not UTF-16 code units or UTF-8 bytes), so an emoji or accented letter counts once.'
13501
+
description: 'Unicode code point offsets [start, end) into the state text: index code points (not UTF-16 code units or UTF-8 bytes), so an emoji or accented letter counts once. Absent for an answer that has no offsets in the state text, for example a null answer, one read from an image or a document, or one the provider returned without offsets that delimit it.'
13484
13502
items:
13485
13503
type: 'integer'
13486
13504
maxItems: 2
@@ -13518,6 +13536,9 @@ components:
13518
13536
enum:
13519
13537
- 'text'
13520
13538
type: 'string'
13539
+
unit:
13540
+
description: 'Unit label for the value.'
13541
+
type: 'string'
13521
13542
required:
13522
13543
- 'type'
13523
13544
type: 'object'
@@ -13541,7 +13562,7 @@ components:
13541
13562
- 'document'
13542
13563
type: 'string'
13543
13564
span:
13544
-
description: 'Unicode code point offsets [start, end) into the state text: index code points (not UTF-16 code units or UTF-8 bytes), so an emoji or accented letter counts once.'
13565
+
description: 'Unicode code point offsets [start, end) into the state text: index code points (not UTF-16 code units or UTF-8 bytes), so an emoji or accented letter counts once. Absent for an answer that has no offsets in the state text, for example a null answer, one read from an image or a document, or one the provider returned without offsets that delimit it.'
13545
13566
items:
13546
13567
type: 'integer'
13547
13568
maxItems: 2
@@ -13579,6 +13600,9 @@ components:
13579
13600
enum:
13580
13601
- 'time'
13581
13602
type: 'string'
13603
+
unit:
13604
+
description: 'Unit label for the value.'
13605
+
type: 'string'
13582
13606
required:
13583
13607
- 'type'
13584
13608
type: 'object'
@@ -36575,7 +36599,7 @@ components:
36575
36599
name: 'Updated Langfuse'
36576
36600
properties:
36577
36601
api_key_hashes:
36578
-
description: '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.'
36602
+
description: 'Optional allowlist of OpenRouter API key hashes. `null` clears the filter (all keys). Omitting leaves the current value, including any API key from another workspace that an organization-scoped key attached. Must contain at least one hash if provided. A workspace-scoped management key can only name API keys in its own workspace; any other hash returns 400.'
36579
36603
example: null
36580
36604
items:
36581
36605
type: 'string'
@@ -52375,7 +52399,7 @@ paths:
52375
52399
- 'OAuth'
52376
52400
/observability/destinations:
52377
52401
get:
52378
-
description: '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](/docs/guides/overview/auth/management-api-keys) required.'
52402
+
description: 'List the observability destinations configured 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. A workspace-scoped management key can only list its own workspace; any other `workspace_id` returns 403. Only destinations with stable release status are surfaced — destinations of other types are excluded. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
52379
52403
operationId: 'listObservabilityDestinations'
52380
52404
parameters:
52381
52405
- description: 'Number of records to skip for pagination'
@@ -52401,12 +52425,12 @@ paths:
52401
52425
maximum: 100
52402
52426
minimum: 1
52403
52427
type: 'integer'
52404
-
- description: 'Optional workspace ID to filter by. Defaults to the authenticated entity''s default workspace.'
52428
+
- description: 'Optional workspace ID to filter by. Defaults to the authenticated entity''s default workspace, or a workspace-scoped management key''s own workspace.'
52405
52429
in: 'query'
52406
52430
name: 'workspace_id'
52407
52431
required: false
52408
52432
schema:
52409
-
description: 'Optional workspace ID to filter by. Defaults to the authenticated entity''s default workspace.'
52433
+
description: 'Optional workspace ID to filter by. Defaults to the authenticated entity''s default workspace, or a workspace-scoped management key''s own workspace.'
52410
52434
example: '550e8400-e29b-41d4-a716-446655440000'
52411
52435
format: 'uuid'
52412
52436
type: 'string'
@@ -52497,7 +52521,7 @@ paths:
52497
52521
results: '$.data'
52498
52522
type: 'offsetLimit'
52499
52523
post:
52500
-
description: '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](/docs/guides/overview/auth/management-api-keys) required.'
52524
+
description: 'Create a new observability destination. A maximum of 5 destinations per type is allowed. Defaults to the authenticated entity''s default workspace, or a workspace-scoped management key''s own workspace; use the `workspace_id` body field to scope to a different workspace. A workspace-scoped management key can only create in its own workspace; any other `workspace_id` returns 403. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
52501
52525
operationId: 'createObservabilityDestination'
52502
52526
requestBody:
52503
52527
content:
@@ -52598,7 +52622,7 @@ paths:
52598
52622
x-speakeasy-name-override: 'create'
52599
52623
/observability/destinations/{id}:
52600
52624
delete:
52601
-
description: 'Delete an existing observability destination. This performs a soft delete. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
52625
+
description: 'Delete an existing observability destination. This performs a soft delete. A workspace-scoped management key only reaches destinations in its own workspace; any other `id` returns 404. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
52602
52626
operationId: 'deleteObservabilityDestination'
52603
52627
parameters:
52604
52628
- description: 'The destination ID (UUID).'
@@ -52664,7 +52688,7 @@ paths:
52664
52688
- 'Observability'
52665
52689
x-speakeasy-name-override: 'delete'
52666
52690
get:
52667
-
description: 'Fetch a single observability destination by its UUID. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
52691
+
description: 'Fetch a single observability destination by its UUID. A workspace-scoped management key only reaches destinations in its own workspace; any other `id` returns 404. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
52668
52692
operationId: 'getObservabilityDestination'
52669
52693
parameters:
52670
52694
- description: 'The destination ID (UUID).'
@@ -52751,7 +52775,7 @@ paths:
52751
52775
- 'Observability'
52752
52776
x-speakeasy-name-override: 'get'
52753
52777
patch:
52754
-
description: 'Update an existing observability destination. Only the fields provided in the request body are updated. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
52778
+
description: 'Update an existing observability destination. Only the fields provided in the request body are updated. A workspace-scoped management key only reaches destinations in its own workspace; any other `id` returns 404. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
0 commit comments