@ellipsis-dev/sdk 0.25.0 → 0.27.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +19 -13
- package/dist/index.js +18 -15
- package/dist/store/index.d.ts +33 -4
- package/dist/store/index.js +238 -65
- package/dist/stream/index.d.ts +1 -1
- package/dist/{types-DJzmFABi.d.ts → types-ClEF_IA9.d.ts} +109 -38
- package/package.json +1 -1
- package/schema/frames.schema.json +41 -4
- package/schema/openapi.v1.json +131 -36
package/schema/openapi.v1.json
CHANGED
|
@@ -2431,7 +2431,7 @@
|
|
|
2431
2431
|
"properties": {
|
|
2432
2432
|
"automation": {
|
|
2433
2433
|
"$ref": "#/components/schemas/AutomationConfig",
|
|
2434
|
-
"description": "The automation's definition, in the same schema as a YAML file under
|
|
2434
|
+
"description": "The automation's definition, in the same schema as a YAML file under .ellipsis/."
|
|
2435
2435
|
}
|
|
2436
2436
|
},
|
|
2437
2437
|
"required": [
|
|
@@ -4450,6 +4450,33 @@
|
|
|
4450
4450
|
"title": "Harness",
|
|
4451
4451
|
"type": "string"
|
|
4452
4452
|
},
|
|
4453
|
+
"ImageAttachment": {
|
|
4454
|
+
"description": "One image on a request body, base64 inline (the Claude Code paste\nshape). Shared by `POST /v1/sessions` and `POST /v1/sessions/{id}/messages`.",
|
|
4455
|
+
"properties": {
|
|
4456
|
+
"data": {
|
|
4457
|
+
"description": "The raw image bytes, base64-encoded. 5 MiB cap.",
|
|
4458
|
+
"title": "Data",
|
|
4459
|
+
"type": "string"
|
|
4460
|
+
},
|
|
4461
|
+
"media_type": {
|
|
4462
|
+
"description": "The image's MIME type: image/png, image/jpeg, image/gif, or image/webp. The bytes must match.",
|
|
4463
|
+
"enum": [
|
|
4464
|
+
"image/png",
|
|
4465
|
+
"image/jpeg",
|
|
4466
|
+
"image/gif",
|
|
4467
|
+
"image/webp"
|
|
4468
|
+
],
|
|
4469
|
+
"title": "Media Type",
|
|
4470
|
+
"type": "string"
|
|
4471
|
+
}
|
|
4472
|
+
},
|
|
4473
|
+
"required": [
|
|
4474
|
+
"media_type",
|
|
4475
|
+
"data"
|
|
4476
|
+
],
|
|
4477
|
+
"title": "ImageAttachment",
|
|
4478
|
+
"type": "object"
|
|
4479
|
+
},
|
|
4453
4480
|
"IngestTranscriptRequest": {
|
|
4454
4481
|
"description": "A batch of raw transcript lines pushed from inside a session's\nsandbox.",
|
|
4455
4482
|
"properties": {
|
|
@@ -4795,7 +4822,7 @@
|
|
|
4795
4822
|
"type": "null"
|
|
4796
4823
|
}
|
|
4797
4824
|
],
|
|
4798
|
-
"description": "File path within the repo. Omit for the default
|
|
4825
|
+
"description": "File path within the repo. Omit for the default .ellipsis/automations/<slug>.yaml; if set it must be a location the sync scans (a .yaml/.yml file under .ellipsis/ at any depth; in the repository named .ellipsis the repo root is that directory).",
|
|
4799
4826
|
"title": "Path"
|
|
4800
4827
|
},
|
|
4801
4828
|
"repository": {
|
|
@@ -5340,18 +5367,6 @@
|
|
|
5340
5367
|
"$ref": "#/components/schemas/BudgetCeiling",
|
|
5341
5368
|
"description": "The organization's spend ceilings."
|
|
5342
5369
|
},
|
|
5343
|
-
"default_environment": {
|
|
5344
|
-
"anyOf": [
|
|
5345
|
-
{
|
|
5346
|
-
"type": "string"
|
|
5347
|
-
},
|
|
5348
|
-
{
|
|
5349
|
-
"type": "null"
|
|
5350
|
-
}
|
|
5351
|
-
],
|
|
5352
|
-
"description": "The saved environment sessions run in when neither their request nor their automation names one: an `env_...` id or the environment's name on write, always the id on read. Null means the built-in basic sandbox.",
|
|
5353
|
-
"title": "Default Environment"
|
|
5354
|
-
},
|
|
5355
5370
|
"default_model": {
|
|
5356
5371
|
"anyOf": [
|
|
5357
5372
|
{
|
|
@@ -8472,8 +8487,16 @@
|
|
|
8472
8487
|
"description": "Optional retry-safety key, unique per (session, key): a retry with the same key returns the original message \u2014 no duplicate message, no double turn, no double spend. The SDK auto-generates one per send.",
|
|
8473
8488
|
"title": "Idempotency Key"
|
|
8474
8489
|
},
|
|
8490
|
+
"images": {
|
|
8491
|
+
"description": "Images attached to the message, base64 inline \u2014 what a paste into Claude Code sends. Each becomes an `[Image #N]` placeholder in the stored body and an image block the model sees on the turn this message opens. Up to 10, 5 MiB each; PNG, JPEG, GIF, or WebP. Claude harness only.",
|
|
8492
|
+
"items": {
|
|
8493
|
+
"$ref": "#/components/schemas/ImageAttachment"
|
|
8494
|
+
},
|
|
8495
|
+
"title": "Images",
|
|
8496
|
+
"type": "array"
|
|
8497
|
+
},
|
|
8475
8498
|
"message": {
|
|
8476
|
-
"description": "The message text.",
|
|
8499
|
+
"description": "The message text. May be empty when `images` is not.",
|
|
8477
8500
|
"title": "Message",
|
|
8478
8501
|
"type": "string"
|
|
8479
8502
|
}
|
|
@@ -8682,7 +8705,7 @@
|
|
|
8682
8705
|
},
|
|
8683
8706
|
"source": {
|
|
8684
8707
|
"$ref": "#/components/schemas/SessionSource",
|
|
8685
|
-
"description": "Where the session came from (e.g. react,
|
|
8708
|
+
"description": "Where the session came from (e.g. react, web, api, cli, mention, cron)."
|
|
8686
8709
|
},
|
|
8687
8710
|
"status": {
|
|
8688
8711
|
"$ref": "#/components/schemas/SessionStatus",
|
|
@@ -8989,7 +9012,7 @@
|
|
|
8989
9012
|
"type": "null"
|
|
8990
9013
|
}
|
|
8991
9014
|
],
|
|
8992
|
-
"description": "How the environment was chosen (request, agent_config, repo_default
|
|
9015
|
+
"description": "How the environment was chosen (request, agent_config, platform_default; repo_default and account_default on sessions from before those ladders were removed). Null when the config carried its own inline environment."
|
|
8993
9016
|
}
|
|
8994
9017
|
},
|
|
8995
9018
|
"title": "SessionEnvironment",
|
|
@@ -9302,7 +9325,7 @@
|
|
|
9302
9325
|
"title": "Author"
|
|
9303
9326
|
},
|
|
9304
9327
|
"body": {
|
|
9305
|
-
"description": "The message text.",
|
|
9328
|
+
"description": "The message text, with one `[Image #N]` placeholder per attached image.",
|
|
9306
9329
|
"title": "Body",
|
|
9307
9330
|
"type": "string"
|
|
9308
9331
|
},
|
|
@@ -9354,6 +9377,14 @@
|
|
|
9354
9377
|
"title": "Id",
|
|
9355
9378
|
"type": "string"
|
|
9356
9379
|
},
|
|
9380
|
+
"images": {
|
|
9381
|
+
"description": "Images attached to the message, metadata only: index, media type, size. The bytes go to the model, never over the stream.",
|
|
9382
|
+
"items": {
|
|
9383
|
+
"$ref": "#/components/schemas/SessionMessageImage"
|
|
9384
|
+
},
|
|
9385
|
+
"title": "Images",
|
|
9386
|
+
"type": "array"
|
|
9387
|
+
},
|
|
9357
9388
|
"sender_attribution_id": {
|
|
9358
9389
|
"anyOf": [
|
|
9359
9390
|
{
|
|
@@ -9397,6 +9428,33 @@
|
|
|
9397
9428
|
"title": "SessionMessage",
|
|
9398
9429
|
"type": "object"
|
|
9399
9430
|
},
|
|
9431
|
+
"SessionMessageImage": {
|
|
9432
|
+
"description": "One image on a message, metadata only. `index` is the N in the\n`[Image #N]` placeholder in the message body.",
|
|
9433
|
+
"properties": {
|
|
9434
|
+
"index": {
|
|
9435
|
+
"description": "1-based position: the N in `[Image #N]`.",
|
|
9436
|
+
"title": "Index",
|
|
9437
|
+
"type": "integer"
|
|
9438
|
+
},
|
|
9439
|
+
"media_type": {
|
|
9440
|
+
"description": "The image's MIME type.",
|
|
9441
|
+
"title": "Media Type",
|
|
9442
|
+
"type": "string"
|
|
9443
|
+
},
|
|
9444
|
+
"size_bytes": {
|
|
9445
|
+
"description": "Size of the decoded image, in bytes.",
|
|
9446
|
+
"title": "Size Bytes",
|
|
9447
|
+
"type": "integer"
|
|
9448
|
+
}
|
|
9449
|
+
},
|
|
9450
|
+
"required": [
|
|
9451
|
+
"index",
|
|
9452
|
+
"media_type",
|
|
9453
|
+
"size_bytes"
|
|
9454
|
+
],
|
|
9455
|
+
"title": "SessionMessageImage",
|
|
9456
|
+
"type": "object"
|
|
9457
|
+
},
|
|
9400
9458
|
"SessionMessageResponse": {
|
|
9401
9459
|
"description": "One inbox message.",
|
|
9402
9460
|
"properties": {
|
|
@@ -9598,9 +9656,10 @@
|
|
|
9598
9656
|
"type": "object"
|
|
9599
9657
|
},
|
|
9600
9658
|
"SessionSource": {
|
|
9659
|
+
"description": "Where a session came from: the credential that started it (web app,\nAPI key, CLI) or the trigger that fired (react, mention, cron). Never\ntaken from a request body.",
|
|
9601
9660
|
"enum": [
|
|
9602
9661
|
"react",
|
|
9603
|
-
"
|
|
9662
|
+
"web",
|
|
9604
9663
|
"api",
|
|
9605
9664
|
"cli",
|
|
9606
9665
|
"mention",
|
|
@@ -10145,7 +10204,7 @@
|
|
|
10145
10204
|
"type": "null"
|
|
10146
10205
|
}
|
|
10147
10206
|
],
|
|
10148
|
-
"description": "Where the session runs. A STRING is a saved environment's name or `env_...` id, substituted wholesale. An OBJECT is the whole environment for this session \u2014 `{}` is the bare sandbox
|
|
10207
|
+
"description": "Where the session runs. A STRING is a saved environment's name or `env_...` id, substituted wholesale. An OBJECT is the whole environment for this session \u2014 `{}` is the bare sandbox. Omitted, the session runs in the built-in basic sandbox \u2014 nothing outside the request picks the environment.",
|
|
10149
10208
|
"title": "Environment"
|
|
10150
10209
|
},
|
|
10151
10210
|
"force_rebuild": {
|
|
@@ -10154,6 +10213,14 @@
|
|
|
10154
10213
|
"title": "Force Rebuild",
|
|
10155
10214
|
"type": "boolean"
|
|
10156
10215
|
},
|
|
10216
|
+
"images": {
|
|
10217
|
+
"description": "Images attached to the first message, base64 inline \u2014 what a paste into Claude Code sends. Each becomes an `[Image #N]` placeholder in the prompt and an image block the model sees on turn 0. Up to 10, 5 MiB each; PNG, JPEG, GIF, or WebP. Claude harness only.",
|
|
10218
|
+
"items": {
|
|
10219
|
+
"$ref": "#/components/schemas/ImageAttachment"
|
|
10220
|
+
},
|
|
10221
|
+
"title": "Images",
|
|
10222
|
+
"type": "array"
|
|
10223
|
+
},
|
|
10157
10224
|
"interactive": {
|
|
10158
10225
|
"default": true,
|
|
10159
10226
|
"description": "Whether the session stays open for messages after its first turn. Set false for a one-shot run that does its job and closes without holding a warm sandbox; a one-shot run must carry a prompt, since nothing can ever be sent to it later. Sessions on the Codex harness are one-shot regardless.",
|
|
@@ -14888,7 +14955,7 @@
|
|
|
14888
14955
|
},
|
|
14889
14956
|
"/v1/reviews": {
|
|
14890
14957
|
"get": {
|
|
14891
|
-
"description": "List code reviews, newest first.\n\n`findings` and `configuration` are omitted (counters only). Each\nfilter is a set: repeat `repository`, `pull_request_number`, or\n`status` to match any of several values.\n\nWebhook-created reviews appear here too, so this answers \"show\nme every review on this PR\".",
|
|
14958
|
+
"description": "List code reviews, newest first.\n\n`findings` and `configuration` are omitted (counters only). Each\nfilter is a set: repeat `repository`, `pull_request_number`, or\n`status` to match any of several values. `start` and `end` bound\nthe review's creation time.\n\nWebhook-created reviews appear here too, so this answers \"show\nme every review on this PR\".",
|
|
14892
14959
|
"operationId": "list_reviews",
|
|
14893
14960
|
"parameters": [
|
|
14894
14961
|
{
|
|
@@ -14936,6 +15003,44 @@
|
|
|
14936
15003
|
"type": "array"
|
|
14937
15004
|
}
|
|
14938
15005
|
},
|
|
15006
|
+
{
|
|
15007
|
+
"description": "Only reviews created at or after this time.",
|
|
15008
|
+
"in": "query",
|
|
15009
|
+
"name": "start",
|
|
15010
|
+
"required": false,
|
|
15011
|
+
"schema": {
|
|
15012
|
+
"anyOf": [
|
|
15013
|
+
{
|
|
15014
|
+
"format": "date-time",
|
|
15015
|
+
"type": "string"
|
|
15016
|
+
},
|
|
15017
|
+
{
|
|
15018
|
+
"type": "null"
|
|
15019
|
+
}
|
|
15020
|
+
],
|
|
15021
|
+
"description": "Only reviews created at or after this time.",
|
|
15022
|
+
"title": "Start"
|
|
15023
|
+
}
|
|
15024
|
+
},
|
|
15025
|
+
{
|
|
15026
|
+
"description": "Only reviews created at or before this time.",
|
|
15027
|
+
"in": "query",
|
|
15028
|
+
"name": "end",
|
|
15029
|
+
"required": false,
|
|
15030
|
+
"schema": {
|
|
15031
|
+
"anyOf": [
|
|
15032
|
+
{
|
|
15033
|
+
"format": "date-time",
|
|
15034
|
+
"type": "string"
|
|
15035
|
+
},
|
|
15036
|
+
{
|
|
15037
|
+
"type": "null"
|
|
15038
|
+
}
|
|
15039
|
+
],
|
|
15040
|
+
"description": "Only reviews created at or before this time.",
|
|
15041
|
+
"title": "End"
|
|
15042
|
+
}
|
|
15043
|
+
},
|
|
14939
15044
|
{
|
|
14940
15045
|
"in": "query",
|
|
14941
15046
|
"name": "limit",
|
|
@@ -15751,7 +15856,7 @@
|
|
|
15751
15856
|
"x-ellipsis-sdk-method": "sessions.list"
|
|
15752
15857
|
},
|
|
15753
15858
|
"post": {
|
|
15754
|
-
"description": "Start a cloud agent session.\n\nThe daily driver: a prompt, optionally where to run it\n(`environment`) and the run's own settings, in the AutomationConfig\nvocabulary.
|
|
15859
|
+
"description": "Start a cloud agent session.\n\nThe daily driver: a prompt, optionally where to run it\n(`environment`) and the run's own settings, in the AutomationConfig\nvocabulary. What you send is what runs: omit `environment` and the\nsession runs in the built-in basic sandbox. A missing model or\nbudget comes from the organization's settings, so\n`{\"prompt\": \"...\"}` alone is a complete request. `prompt` is the\nfirst message; omit it and the session starts idle, waiting for\none. 400 when `interactive` is false and there is no prompt, or\nwhen `budget` exceeds the organization's per-session ceiling. To\nrun a saved automation, use POST /v1/automations/{automation_id}/sessions.",
|
|
15755
15860
|
"operationId": "start_agent_session",
|
|
15756
15861
|
"parameters": [
|
|
15757
15862
|
{
|
|
@@ -15800,7 +15905,7 @@
|
|
|
15800
15905
|
}
|
|
15801
15906
|
}
|
|
15802
15907
|
},
|
|
15803
|
-
"description": "The request is incompatible with itself (a one-shot run with no prompt,
|
|
15908
|
+
"description": "The request is incompatible with itself (a one-shot run with no prompt, both `claude` and `codex`, or images on the Codex harness), an image is invalid or over the limit, its keys produce an invalid config, or `budget` exceeds the organization's per-session ceiling."
|
|
15804
15909
|
},
|
|
15805
15910
|
"401": {
|
|
15806
15911
|
"content": {
|
|
@@ -16200,7 +16305,7 @@
|
|
|
16200
16305
|
}
|
|
16201
16306
|
}
|
|
16202
16307
|
},
|
|
16203
|
-
"description": "The message is empty."
|
|
16308
|
+
"description": "The message is empty (no text and no images), an image is invalid or over the limit, or the session runs on the Codex harness (images are Claude-only)."
|
|
16204
16309
|
},
|
|
16205
16310
|
"401": {
|
|
16206
16311
|
"content": {
|
|
@@ -16712,7 +16817,7 @@
|
|
|
16712
16817
|
},
|
|
16713
16818
|
"/v1/settings/organization": {
|
|
16714
16819
|
"get": {
|
|
16715
|
-
"description": "Get the organization settings.\n\nThe default model
|
|
16820
|
+
"description": "Get the organization settings.\n\nThe default model every session falls back to when neither its\nrequest nor its automation names one, and the per-session budget\nceiling no session may exceed.",
|
|
16716
16821
|
"operationId": "get_organization_settings",
|
|
16717
16822
|
"parameters": [
|
|
16718
16823
|
{
|
|
@@ -16786,7 +16891,7 @@
|
|
|
16786
16891
|
"x-ellipsis-sdk-method": "settings.organization.get"
|
|
16787
16892
|
},
|
|
16788
16893
|
"put": {
|
|
16789
|
-
"description": "Set the organization settings.\n\nReplaces
|
|
16894
|
+
"description": "Set the organization settings.\n\nReplaces both: `default_model` accepts an alias or canonical id\nand is stored canonical; `budget_ceiling.session` is in US\ndollars, at most the platform ceiling. Null clears each.\nRefused for sandbox tokens (potentially prompt-injected code must\nnot repoint the organization's defaults).",
|
|
16790
16895
|
"operationId": "put_organization_settings",
|
|
16791
16896
|
"parameters": [
|
|
16792
16897
|
{
|
|
@@ -16857,16 +16962,6 @@
|
|
|
16857
16962
|
},
|
|
16858
16963
|
"description": "The credential may not perform this action, or the account is blocked."
|
|
16859
16964
|
},
|
|
16860
|
-
"404": {
|
|
16861
|
-
"content": {
|
|
16862
|
-
"application/json": {
|
|
16863
|
-
"schema": {
|
|
16864
|
-
"$ref": "#/components/schemas/ErrorResponse"
|
|
16865
|
-
}
|
|
16866
|
-
}
|
|
16867
|
-
},
|
|
16868
|
-
"description": "The default environment does not exist in your account."
|
|
16869
|
-
},
|
|
16870
16965
|
"422": {
|
|
16871
16966
|
"content": {
|
|
16872
16967
|
"application/json": {
|