@ellipsis-dev/sdk 0.16.0 → 0.18.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 +118 -100
- package/dist/index.js +134 -94
- package/dist/store/index.d.ts +1 -1
- package/dist/stream/index.d.ts +1 -1
- package/dist/{types-DB1hOyQE.d.ts → types-BLSh1Px1.d.ts} +977 -591
- package/package.json +1 -1
- package/schema/frames.schema.json +168 -33
- package/schema/openapi.v1.json +1450 -923
package/schema/openapi.v1.json
CHANGED
|
@@ -11,7 +11,6 @@
|
|
|
11
11
|
"claude": {
|
|
12
12
|
"$ref": "#/components/schemas/AgentConfigClaude",
|
|
13
13
|
"default": {
|
|
14
|
-
"model": "claude-opus-5",
|
|
15
14
|
"system": ""
|
|
16
15
|
}
|
|
17
16
|
},
|
|
@@ -29,7 +28,6 @@
|
|
|
29
28
|
"$ref": "#/components/schemas/AgentConfigEllipsis",
|
|
30
29
|
"default": {
|
|
31
30
|
"enabled": true,
|
|
32
|
-
"interactive": true,
|
|
33
31
|
"metadata": {
|
|
34
32
|
"annotations": {},
|
|
35
33
|
"labels": []
|
|
@@ -38,14 +36,23 @@
|
|
|
38
36
|
}
|
|
39
37
|
},
|
|
40
38
|
"environment": {
|
|
41
|
-
"
|
|
39
|
+
"anyOf": [
|
|
40
|
+
{
|
|
41
|
+
"type": "string"
|
|
42
|
+
},
|
|
43
|
+
{
|
|
44
|
+
"$ref": "#/components/schemas/AgentConfigEnvironment"
|
|
45
|
+
}
|
|
46
|
+
],
|
|
42
47
|
"default": {
|
|
43
48
|
"compute": {},
|
|
44
49
|
"hooks": {},
|
|
45
50
|
"image": {},
|
|
51
|
+
"mcp_servers": [],
|
|
46
52
|
"repositories": [],
|
|
47
53
|
"variables": []
|
|
48
|
-
}
|
|
54
|
+
},
|
|
55
|
+
"title": "Environment"
|
|
49
56
|
},
|
|
50
57
|
"input": {
|
|
51
58
|
"anyOf": [
|
|
@@ -57,21 +64,6 @@
|
|
|
57
64
|
}
|
|
58
65
|
]
|
|
59
66
|
},
|
|
60
|
-
"mcp_servers": {
|
|
61
|
-
"default": [],
|
|
62
|
-
"items": {
|
|
63
|
-
"anyOf": [
|
|
64
|
-
{
|
|
65
|
-
"type": "string"
|
|
66
|
-
},
|
|
67
|
-
{
|
|
68
|
-
"$ref": "#/components/schemas/AgentConfigMcpServer"
|
|
69
|
-
}
|
|
70
|
-
]
|
|
71
|
-
},
|
|
72
|
-
"title": "Mcp Servers",
|
|
73
|
-
"type": "array"
|
|
74
|
-
},
|
|
75
67
|
"output": {
|
|
76
68
|
"anyOf": [
|
|
77
69
|
{
|
|
@@ -218,9 +210,15 @@
|
|
|
218
210
|
"title": "Max Turns"
|
|
219
211
|
},
|
|
220
212
|
"model": {
|
|
221
|
-
"
|
|
222
|
-
|
|
223
|
-
|
|
213
|
+
"anyOf": [
|
|
214
|
+
{
|
|
215
|
+
"type": "string"
|
|
216
|
+
},
|
|
217
|
+
{
|
|
218
|
+
"type": "null"
|
|
219
|
+
}
|
|
220
|
+
],
|
|
221
|
+
"title": "Model"
|
|
224
222
|
},
|
|
225
223
|
"settings": {
|
|
226
224
|
"anyOf": [
|
|
@@ -414,7 +412,7 @@
|
|
|
414
412
|
},
|
|
415
413
|
"AgentConfigEllipsis": {
|
|
416
414
|
"additionalProperties": false,
|
|
417
|
-
"description": "The Ellipsis product namespace for a config file: which schema this is\n(`version`), the human-facing identity (`name`/`description`), freeform\norganizational `metadata`, whether the agent is `enabled
|
|
415
|
+
"description": "The Ellipsis product namespace for a config file: which schema this is\n(`version`), the human-facing identity (`name`/`description`), freeform\norganizational `metadata`, and whether the agent is `enabled`. The\npresence of a top-level `ellipsis:` mapping is what marks a YAML file as\nan Ellipsis agent config (vs arbitrary YAML that merely lives under a\nconfig directory) \u2014 see `yaml_is_ellipsis_config`.\n\n`enabled` is agent behavior, not freeform metadata, so it stays inside\nthe config `sha` (only `metadata` is sha-excluded). Whether a session\naccepts messages is a per-run choice (POST /v1/sessions `interactive`),\nnot a config one.",
|
|
418
416
|
"properties": {
|
|
419
417
|
"description": {
|
|
420
418
|
"anyOf": [
|
|
@@ -432,11 +430,6 @@
|
|
|
432
430
|
"title": "Enabled",
|
|
433
431
|
"type": "boolean"
|
|
434
432
|
},
|
|
435
|
-
"interactive": {
|
|
436
|
-
"default": true,
|
|
437
|
-
"title": "Interactive",
|
|
438
|
-
"type": "boolean"
|
|
439
|
-
},
|
|
440
433
|
"metadata": {
|
|
441
434
|
"$ref": "#/components/schemas/AgentConfigMetadata",
|
|
442
435
|
"default": {
|
|
@@ -511,6 +504,27 @@
|
|
|
511
504
|
"$ref": "#/components/schemas/AgentConfigEnvironmentImage",
|
|
512
505
|
"default": {}
|
|
513
506
|
},
|
|
507
|
+
"mcp_servers": {
|
|
508
|
+
"default": [],
|
|
509
|
+
"items": {
|
|
510
|
+
"anyOf": [
|
|
511
|
+
{
|
|
512
|
+
"type": "string"
|
|
513
|
+
},
|
|
514
|
+
{
|
|
515
|
+
"$ref": "#/components/schemas/AgentConfigMcpServer"
|
|
516
|
+
},
|
|
517
|
+
{
|
|
518
|
+
"$ref": "#/components/schemas/AgentConfigMcpStdioServer"
|
|
519
|
+
},
|
|
520
|
+
{
|
|
521
|
+
"$ref": "#/components/schemas/AgentConfigMcpRemoteServer"
|
|
522
|
+
}
|
|
523
|
+
]
|
|
524
|
+
},
|
|
525
|
+
"title": "Mcp Servers",
|
|
526
|
+
"type": "array"
|
|
527
|
+
},
|
|
514
528
|
"repositories": {
|
|
515
529
|
"default": [],
|
|
516
530
|
"items": {
|
|
@@ -688,9 +702,37 @@
|
|
|
688
702
|
"title": "AgentConfigInput",
|
|
689
703
|
"type": "object"
|
|
690
704
|
},
|
|
705
|
+
"AgentConfigMcpRemoteServer": {
|
|
706
|
+
"additionalProperties": false,
|
|
707
|
+
"description": "A bring-your-own remote MCP server: the harness talks HTTP to `url`.\nNothing runs in the sandbox image. `headers` carry static auth (e.g.\n`Authorization: Bearer ${TOKEN}`); values may embed `${NAME}` secret\nreferences, resolved at run time from the account's secrets store.",
|
|
708
|
+
"properties": {
|
|
709
|
+
"headers": {
|
|
710
|
+
"additionalProperties": {
|
|
711
|
+
"type": "string"
|
|
712
|
+
},
|
|
713
|
+
"default": {},
|
|
714
|
+
"title": "Headers",
|
|
715
|
+
"type": "object"
|
|
716
|
+
},
|
|
717
|
+
"name": {
|
|
718
|
+
"title": "Name",
|
|
719
|
+
"type": "string"
|
|
720
|
+
},
|
|
721
|
+
"url": {
|
|
722
|
+
"title": "Url",
|
|
723
|
+
"type": "string"
|
|
724
|
+
}
|
|
725
|
+
},
|
|
726
|
+
"required": [
|
|
727
|
+
"name",
|
|
728
|
+
"url"
|
|
729
|
+
],
|
|
730
|
+
"title": "AgentConfigMcpRemoteServer",
|
|
731
|
+
"type": "object"
|
|
732
|
+
},
|
|
691
733
|
"AgentConfigMcpServer": {
|
|
692
734
|
"additionalProperties": false,
|
|
693
|
-
"description": "One built-in MCP server this agent opts into by name (`linear`/`slack`).\
|
|
735
|
+
"description": "One built-in MCP server this agent opts into by name (`linear`/`slack`).\nA name reference over the connected built-in set \u2014 the platform manages the\nserver's transport and credentials. It only matters when the named\nintegration is set to `opt_in` inclusion; an integration in the default\n`all_sessions` mode is added regardless. For a server the platform does not\nprovide, define it instead (`AgentConfigMcpStdioServer` /\n`AgentConfigMcpRemoteServer`).",
|
|
694
736
|
"properties": {
|
|
695
737
|
"name": {
|
|
696
738
|
"title": "Name",
|
|
@@ -703,6 +745,42 @@
|
|
|
703
745
|
"title": "AgentConfigMcpServer",
|
|
704
746
|
"type": "object"
|
|
705
747
|
},
|
|
748
|
+
"AgentConfigMcpStdioServer": {
|
|
749
|
+
"additionalProperties": false,
|
|
750
|
+
"description": "A bring-your-own stdio MCP server: the harness spawns `command` inside\nthe sandbox and speaks JSON-RPC over its stdin/stdout. The command must be\nrunnable in the sandbox image \u2014 install its runtime via `image.setup` /\n`image.dockerfile_append` if the base image lacks it.\n\n`env` values may embed `${NAME}` references, resolved at run time from the\naccount's secrets store (see `mcp_secret_refs`); everything else is passed\nliterally.",
|
|
751
|
+
"properties": {
|
|
752
|
+
"args": {
|
|
753
|
+
"default": [],
|
|
754
|
+
"items": {
|
|
755
|
+
"type": "string"
|
|
756
|
+
},
|
|
757
|
+
"title": "Args",
|
|
758
|
+
"type": "array"
|
|
759
|
+
},
|
|
760
|
+
"command": {
|
|
761
|
+
"title": "Command",
|
|
762
|
+
"type": "string"
|
|
763
|
+
},
|
|
764
|
+
"env": {
|
|
765
|
+
"additionalProperties": {
|
|
766
|
+
"type": "string"
|
|
767
|
+
},
|
|
768
|
+
"default": {},
|
|
769
|
+
"title": "Env",
|
|
770
|
+
"type": "object"
|
|
771
|
+
},
|
|
772
|
+
"name": {
|
|
773
|
+
"title": "Name",
|
|
774
|
+
"type": "string"
|
|
775
|
+
}
|
|
776
|
+
},
|
|
777
|
+
"required": [
|
|
778
|
+
"name",
|
|
779
|
+
"command"
|
|
780
|
+
],
|
|
781
|
+
"title": "AgentConfigMcpStdioServer",
|
|
782
|
+
"type": "object"
|
|
783
|
+
},
|
|
706
784
|
"AgentConfigMemorySize": {
|
|
707
785
|
"additionalProperties": false,
|
|
708
786
|
"description": "A memory size as explicit units, summed (binary: 1GB = 1024MB = 1024MiB).\nSet any of `gb`/`mb` (at least one). The alternative to the `8GB`-style\nshorthand string.",
|
|
@@ -736,10 +814,9 @@
|
|
|
736
814
|
"type": "object"
|
|
737
815
|
},
|
|
738
816
|
"AgentConfigMentionPlatform": {
|
|
739
|
-
"description": "The surface an @ellipsis mention can come from.",
|
|
817
|
+
"description": "The surface an @ellipsis mention can come from.\n\nNo SLACK member: Slack routing is not a trigger on an agent config, it is the\n`slack.yaml` routing file (`SlackConfig`), which answers the questions a\nplatform list cannot \u2014 which channel, and whose DM. A mention trigger listing\n`slack` is therefore a config error, not a silently-never-fires config.",
|
|
740
818
|
"enum": [
|
|
741
819
|
"github",
|
|
742
|
-
"slack",
|
|
743
820
|
"linear"
|
|
744
821
|
],
|
|
745
822
|
"title": "AgentConfigMentionPlatform",
|
|
@@ -1086,34 +1163,6 @@
|
|
|
1086
1163
|
"title": "AgentConfigsListResponse",
|
|
1087
1164
|
"type": "object"
|
|
1088
1165
|
},
|
|
1089
|
-
"AgentDefaults": {
|
|
1090
|
-
"description": "Which agent config serves sessions started without an explicit config:\none account-wide rung, plus a rung per repository.\n\nValues are config ids \u2014 stable across renames, unlike the agent's name.\nA repo rung whose repository this installation can no longer see is absent\nfrom `repositories`; its row is left in place, so re-installing the repo\nbrings the rung back.",
|
|
1091
|
-
"properties": {
|
|
1092
|
-
"account": {
|
|
1093
|
-
"anyOf": [
|
|
1094
|
-
{
|
|
1095
|
-
"type": "string"
|
|
1096
|
-
},
|
|
1097
|
-
{
|
|
1098
|
-
"type": "null"
|
|
1099
|
-
}
|
|
1100
|
-
],
|
|
1101
|
-
"description": "Config id serving sessions with no repository context, or null when no account default is set.",
|
|
1102
|
-
"title": "Account"
|
|
1103
|
-
},
|
|
1104
|
-
"repositories": {
|
|
1105
|
-
"additionalProperties": {
|
|
1106
|
-
"type": "string"
|
|
1107
|
-
},
|
|
1108
|
-
"default": {},
|
|
1109
|
-
"description": "Config id per repository, keyed \"owner/name\". A repository with no default set is absent.",
|
|
1110
|
-
"title": "Repositories",
|
|
1111
|
-
"type": "object"
|
|
1112
|
-
}
|
|
1113
|
-
},
|
|
1114
|
-
"title": "AgentDefaults",
|
|
1115
|
-
"type": "object"
|
|
1116
|
-
},
|
|
1117
1166
|
"AgentTemplate": {
|
|
1118
1167
|
"description": "A built-in agent template: a ready-to-use agent config plus the\nmetadata that describes it in the template gallery.",
|
|
1119
1168
|
"properties": {
|
|
@@ -3032,95 +3081,31 @@
|
|
|
3032
3081
|
"type": "object"
|
|
3033
3082
|
},
|
|
3034
3083
|
"CreateAgentConfigRequest": {
|
|
3035
|
-
"description": "Parameters for creating an agent config.
|
|
3084
|
+
"description": "Parameters for creating an agent config.",
|
|
3036
3085
|
"properties": {
|
|
3037
3086
|
"config": {
|
|
3038
|
-
"
|
|
3039
|
-
|
|
3040
|
-
"$ref": "#/components/schemas/AgentConfig"
|
|
3041
|
-
},
|
|
3042
|
-
{
|
|
3043
|
-
"type": "null"
|
|
3044
|
-
}
|
|
3045
|
-
],
|
|
3046
|
-
"description": "An inline agent config."
|
|
3047
|
-
},
|
|
3048
|
-
"path": {
|
|
3049
|
-
"anyOf": [
|
|
3050
|
-
{
|
|
3051
|
-
"type": "string"
|
|
3052
|
-
},
|
|
3053
|
-
{
|
|
3054
|
-
"type": "null"
|
|
3055
|
-
}
|
|
3056
|
-
],
|
|
3057
|
-
"description": "File path within the repo, when a repository is named. Omit for the default agents/<slug>.yaml; if set it must be a location the config sync scans (a .yaml/.yml file under agents/, .agents/, ellipsis/, or .ellipsis/ at any depth).",
|
|
3058
|
-
"title": "Path"
|
|
3059
|
-
},
|
|
3060
|
-
"repository": {
|
|
3061
|
-
"anyOf": [
|
|
3062
|
-
{
|
|
3063
|
-
"type": "string"
|
|
3064
|
-
},
|
|
3065
|
-
{
|
|
3066
|
-
"type": "null"
|
|
3067
|
-
}
|
|
3068
|
-
],
|
|
3069
|
-
"description": "Define the agent as a file in this repository: Ellipsis opens a pull request adding it, and the agent goes live when that merges. Repository name within the caller's account; the owner is always the account, so pass a bare name (e.g. \"my-service\"), not \"owner/my-service\". Omit to create the agent through the API alone, with no file and live immediately.",
|
|
3070
|
-
"title": "Repository"
|
|
3071
|
-
},
|
|
3072
|
-
"template_id": {
|
|
3073
|
-
"anyOf": [
|
|
3074
|
-
{
|
|
3075
|
-
"type": "string"
|
|
3076
|
-
},
|
|
3077
|
-
{
|
|
3078
|
-
"type": "null"
|
|
3079
|
-
}
|
|
3080
|
-
],
|
|
3081
|
-
"description": "A gallery template slug (see GET /v1/agents/templates).",
|
|
3082
|
-
"title": "Template Id"
|
|
3087
|
+
"$ref": "#/components/schemas/AgentConfig",
|
|
3088
|
+
"description": "The agent's definition."
|
|
3083
3089
|
}
|
|
3084
3090
|
},
|
|
3091
|
+
"required": [
|
|
3092
|
+
"config"
|
|
3093
|
+
],
|
|
3085
3094
|
"title": "CreateAgentConfigRequest",
|
|
3086
3095
|
"type": "object"
|
|
3087
3096
|
},
|
|
3088
|
-
"
|
|
3089
|
-
"description": "
|
|
3097
|
+
"CreateEnvironmentRequest": {
|
|
3098
|
+
"description": "Parameters for creating an environment.",
|
|
3090
3099
|
"properties": {
|
|
3091
|
-
"
|
|
3092
|
-
"$ref": "#/components/schemas/
|
|
3093
|
-
"description": "The
|
|
3094
|
-
},
|
|
3095
|
-
"path": {
|
|
3096
|
-
"anyOf": [
|
|
3097
|
-
{
|
|
3098
|
-
"type": "string"
|
|
3099
|
-
},
|
|
3100
|
-
{
|
|
3101
|
-
"type": "null"
|
|
3102
|
-
}
|
|
3103
|
-
],
|
|
3104
|
-
"description": "The file path the config was written to, or null when the agent has no file.",
|
|
3105
|
-
"title": "Path"
|
|
3106
|
-
},
|
|
3107
|
-
"pull_request_url": {
|
|
3108
|
-
"anyOf": [
|
|
3109
|
-
{
|
|
3110
|
-
"type": "string"
|
|
3111
|
-
},
|
|
3112
|
-
{
|
|
3113
|
-
"type": "null"
|
|
3114
|
-
}
|
|
3115
|
-
],
|
|
3116
|
-
"description": "The pull request that adds the config file. The agent becomes live once it merges and syncs. Null when no repository was named: the agent is already live.",
|
|
3117
|
-
"title": "Pull Request Url"
|
|
3100
|
+
"environment": {
|
|
3101
|
+
"$ref": "#/components/schemas/EnvironmentConfig",
|
|
3102
|
+
"description": "The environment's definition."
|
|
3118
3103
|
}
|
|
3119
3104
|
},
|
|
3120
3105
|
"required": [
|
|
3121
|
-
"
|
|
3106
|
+
"environment"
|
|
3122
3107
|
],
|
|
3123
|
-
"title": "
|
|
3108
|
+
"title": "CreateEnvironmentRequest",
|
|
3124
3109
|
"type": "object"
|
|
3125
3110
|
},
|
|
3126
3111
|
"CreateFileRequest": {
|
|
@@ -3358,19 +3343,36 @@
|
|
|
3358
3343
|
"title": "EllipsisGrant",
|
|
3359
3344
|
"type": "object"
|
|
3360
3345
|
},
|
|
3361
|
-
"
|
|
3346
|
+
"Environment": {
|
|
3347
|
+
"description": "A saved environment: the machine agents run in (repositories,\nvariables, MCP servers, image, compute, hooks), defined once and\nreferenced by name or id from agent configs and session starts.",
|
|
3362
3348
|
"properties": {
|
|
3363
|
-
"
|
|
3364
|
-
"description": "
|
|
3365
|
-
"
|
|
3349
|
+
"created_at": {
|
|
3350
|
+
"description": "When the environment was created.",
|
|
3351
|
+
"format": "date-time",
|
|
3352
|
+
"title": "Created At",
|
|
3366
3353
|
"type": "string"
|
|
3367
3354
|
},
|
|
3368
|
-
"
|
|
3369
|
-
"
|
|
3370
|
-
|
|
3355
|
+
"edited_by": {
|
|
3356
|
+
"anyOf": [
|
|
3357
|
+
{
|
|
3358
|
+
"$ref": "#/components/schemas/GithubAccountSnippet"
|
|
3359
|
+
},
|
|
3360
|
+
{
|
|
3361
|
+
"type": "null"
|
|
3362
|
+
}
|
|
3363
|
+
],
|
|
3364
|
+
"description": "The GitHub account that last edited the environment, when known."
|
|
3365
|
+
},
|
|
3366
|
+
"environment": {
|
|
3367
|
+
"$ref": "#/components/schemas/EnvironmentConfig",
|
|
3368
|
+
"description": "The environment definition itself, as parsed from its YAML."
|
|
3369
|
+
},
|
|
3370
|
+
"id": {
|
|
3371
|
+
"description": "Unique identifier of the environment.",
|
|
3372
|
+
"title": "Id",
|
|
3371
3373
|
"type": "string"
|
|
3372
3374
|
},
|
|
3373
|
-
"
|
|
3375
|
+
"last_sync_error": {
|
|
3374
3376
|
"anyOf": [
|
|
3375
3377
|
{
|
|
3376
3378
|
"type": "string"
|
|
@@ -3379,39 +3381,271 @@
|
|
|
3379
3381
|
"type": "null"
|
|
3380
3382
|
}
|
|
3381
3383
|
],
|
|
3382
|
-
"description": "
|
|
3383
|
-
"title": "
|
|
3384
|
-
}
|
|
3385
|
-
|
|
3386
|
-
|
|
3387
|
-
|
|
3388
|
-
|
|
3389
|
-
|
|
3390
|
-
|
|
3391
|
-
|
|
3392
|
-
|
|
3393
|
-
|
|
3394
|
-
|
|
3395
|
-
|
|
3396
|
-
|
|
3397
|
-
|
|
3398
|
-
|
|
3399
|
-
|
|
3400
|
-
|
|
3401
|
-
"
|
|
3402
|
-
|
|
3403
|
-
|
|
3404
|
-
|
|
3405
|
-
|
|
3406
|
-
|
|
3407
|
-
|
|
3408
|
-
|
|
3409
|
-
|
|
3410
|
-
|
|
3411
|
-
"
|
|
3412
|
-
|
|
3413
|
-
|
|
3414
|
-
|
|
3384
|
+
"description": "The parse or validation error from the most recent sync attempt, or null when it succeeded. A non-null value means sessions run the last good definition, not the YAML currently on the branch.",
|
|
3385
|
+
"title": "Last Sync Error"
|
|
3386
|
+
},
|
|
3387
|
+
"last_synced_commit_sha": {
|
|
3388
|
+
"anyOf": [
|
|
3389
|
+
{
|
|
3390
|
+
"type": "string"
|
|
3391
|
+
},
|
|
3392
|
+
{
|
|
3393
|
+
"type": "null"
|
|
3394
|
+
}
|
|
3395
|
+
],
|
|
3396
|
+
"description": "The last commit the environment was synced from.",
|
|
3397
|
+
"title": "Last Synced Commit Sha"
|
|
3398
|
+
},
|
|
3399
|
+
"managed_by": {
|
|
3400
|
+
"$ref": "#/components/schemas/ConfigManagedBy",
|
|
3401
|
+
"description": "\"github\" environments are defined by a file in a repository and are changed by editing that file; \"api\" environments have no file and are changed through this API."
|
|
3402
|
+
},
|
|
3403
|
+
"name": {
|
|
3404
|
+
"description": "The environment's customer-unique addressable name; usable anywhere an environment is referenced, interchangeably with the id.",
|
|
3405
|
+
"title": "Name",
|
|
3406
|
+
"type": "string"
|
|
3407
|
+
},
|
|
3408
|
+
"sha": {
|
|
3409
|
+
"description": "The environment's content identity fingerprint.",
|
|
3410
|
+
"title": "Sha",
|
|
3411
|
+
"type": "string"
|
|
3412
|
+
},
|
|
3413
|
+
"source_details": {
|
|
3414
|
+
"anyOf": [
|
|
3415
|
+
{
|
|
3416
|
+
"$ref": "#/components/schemas/AgentConfigSourceGithub"
|
|
3417
|
+
},
|
|
3418
|
+
{
|
|
3419
|
+
"type": "null"
|
|
3420
|
+
}
|
|
3421
|
+
],
|
|
3422
|
+
"description": "The repository, path, and branch the environment syncs from. Null for environments managed through the API."
|
|
3423
|
+
},
|
|
3424
|
+
"updated_at": {
|
|
3425
|
+
"description": "When the environment was last updated.",
|
|
3426
|
+
"format": "date-time",
|
|
3427
|
+
"title": "Updated At",
|
|
3428
|
+
"type": "string"
|
|
3429
|
+
}
|
|
3430
|
+
},
|
|
3431
|
+
"required": [
|
|
3432
|
+
"id",
|
|
3433
|
+
"name",
|
|
3434
|
+
"sha",
|
|
3435
|
+
"created_at",
|
|
3436
|
+
"updated_at",
|
|
3437
|
+
"managed_by",
|
|
3438
|
+
"environment"
|
|
3439
|
+
],
|
|
3440
|
+
"title": "Environment",
|
|
3441
|
+
"type": "object"
|
|
3442
|
+
},
|
|
3443
|
+
"EnvironmentConfig": {
|
|
3444
|
+
"additionalProperties": false,
|
|
3445
|
+
"description": "A parsed environment document: identity plus the environment body.\n\nThe body fields are flattened to the top level of the file (not nested\nunder an `environment:` key) \u2014 the file *is* the environment, so nesting\nwould be ceremony. `to_environment()` projects the body for substitution\ninto an agent config.",
|
|
3446
|
+
"properties": {
|
|
3447
|
+
"compute": {
|
|
3448
|
+
"$ref": "#/components/schemas/AgentConfigCompute",
|
|
3449
|
+
"default": {}
|
|
3450
|
+
},
|
|
3451
|
+
"ellipsis": {
|
|
3452
|
+
"$ref": "#/components/schemas/EnvironmentConfigEllipsis"
|
|
3453
|
+
},
|
|
3454
|
+
"hooks": {
|
|
3455
|
+
"$ref": "#/components/schemas/AgentConfigEnvironmentHooks",
|
|
3456
|
+
"default": {}
|
|
3457
|
+
},
|
|
3458
|
+
"image": {
|
|
3459
|
+
"$ref": "#/components/schemas/AgentConfigEnvironmentImage",
|
|
3460
|
+
"default": {}
|
|
3461
|
+
},
|
|
3462
|
+
"mcp_servers": {
|
|
3463
|
+
"default": [],
|
|
3464
|
+
"items": {
|
|
3465
|
+
"anyOf": [
|
|
3466
|
+
{
|
|
3467
|
+
"type": "string"
|
|
3468
|
+
},
|
|
3469
|
+
{
|
|
3470
|
+
"$ref": "#/components/schemas/AgentConfigMcpServer"
|
|
3471
|
+
},
|
|
3472
|
+
{
|
|
3473
|
+
"$ref": "#/components/schemas/AgentConfigMcpStdioServer"
|
|
3474
|
+
},
|
|
3475
|
+
{
|
|
3476
|
+
"$ref": "#/components/schemas/AgentConfigMcpRemoteServer"
|
|
3477
|
+
}
|
|
3478
|
+
]
|
|
3479
|
+
},
|
|
3480
|
+
"title": "Mcp Servers",
|
|
3481
|
+
"type": "array"
|
|
3482
|
+
},
|
|
3483
|
+
"repositories": {
|
|
3484
|
+
"default": [],
|
|
3485
|
+
"items": {
|
|
3486
|
+
"$ref": "#/components/schemas/AgentConfigRepository"
|
|
3487
|
+
},
|
|
3488
|
+
"title": "Repositories",
|
|
3489
|
+
"type": "array"
|
|
3490
|
+
},
|
|
3491
|
+
"variables": {
|
|
3492
|
+
"default": [],
|
|
3493
|
+
"items": {
|
|
3494
|
+
"$ref": "#/components/schemas/AgentConfigEnvironmentVariable"
|
|
3495
|
+
},
|
|
3496
|
+
"title": "Variables",
|
|
3497
|
+
"type": "array"
|
|
3498
|
+
}
|
|
3499
|
+
},
|
|
3500
|
+
"required": [
|
|
3501
|
+
"ellipsis"
|
|
3502
|
+
],
|
|
3503
|
+
"title": "EnvironmentConfig",
|
|
3504
|
+
"type": "object"
|
|
3505
|
+
},
|
|
3506
|
+
"EnvironmentConfigEllipsis": {
|
|
3507
|
+
"additionalProperties": false,
|
|
3508
|
+
"description": "The Ellipsis namespace of an environment file. `kind: environment` is\nwhat routes a synced YAML here instead of to the agent-config parser \u2014\nan agent config carries no `kind` (or `kind: agent`, tolerated nowhere:\nabsence is the agent marker).",
|
|
3509
|
+
"properties": {
|
|
3510
|
+
"description": {
|
|
3511
|
+
"anyOf": [
|
|
3512
|
+
{
|
|
3513
|
+
"type": "string"
|
|
3514
|
+
},
|
|
3515
|
+
{
|
|
3516
|
+
"type": "null"
|
|
3517
|
+
}
|
|
3518
|
+
],
|
|
3519
|
+
"title": "Description"
|
|
3520
|
+
},
|
|
3521
|
+
"kind": {
|
|
3522
|
+
"const": "environment",
|
|
3523
|
+
"title": "Kind",
|
|
3524
|
+
"type": "string"
|
|
3525
|
+
},
|
|
3526
|
+
"metadata": {
|
|
3527
|
+
"$ref": "#/components/schemas/AgentConfigMetadata",
|
|
3528
|
+
"default": {
|
|
3529
|
+
"annotations": {},
|
|
3530
|
+
"labels": []
|
|
3531
|
+
}
|
|
3532
|
+
},
|
|
3533
|
+
"name": {
|
|
3534
|
+
"anyOf": [
|
|
3535
|
+
{
|
|
3536
|
+
"type": "string"
|
|
3537
|
+
},
|
|
3538
|
+
{
|
|
3539
|
+
"type": "null"
|
|
3540
|
+
}
|
|
3541
|
+
],
|
|
3542
|
+
"title": "Name"
|
|
3543
|
+
}
|
|
3544
|
+
},
|
|
3545
|
+
"required": [
|
|
3546
|
+
"kind"
|
|
3547
|
+
],
|
|
3548
|
+
"title": "EnvironmentConfigEllipsis",
|
|
3549
|
+
"type": "object"
|
|
3550
|
+
},
|
|
3551
|
+
"EnvironmentResponse": {
|
|
3552
|
+
"description": "One saved environment.",
|
|
3553
|
+
"properties": {
|
|
3554
|
+
"environment": {
|
|
3555
|
+
"$ref": "#/components/schemas/Environment",
|
|
3556
|
+
"description": "The saved environment."
|
|
3557
|
+
}
|
|
3558
|
+
},
|
|
3559
|
+
"required": [
|
|
3560
|
+
"environment"
|
|
3561
|
+
],
|
|
3562
|
+
"title": "EnvironmentResponse",
|
|
3563
|
+
"type": "object"
|
|
3564
|
+
},
|
|
3565
|
+
"EnvironmentSource": {
|
|
3566
|
+
"description": "How a session's environment was chosen. None (the field is nullable)\nwhen the config carried an inline environment block and no resolution ran \u2014\nan inline environment is not a reference, so there is nothing to record.\n\nNot derivable from the row: `environment_id` says WHICH environment, not\nhow it was chosen, and is null for the built-in basic sandbox.",
|
|
3567
|
+
"enum": [
|
|
3568
|
+
"request",
|
|
3569
|
+
"agent_config",
|
|
3570
|
+
"repo_default",
|
|
3571
|
+
"account_default",
|
|
3572
|
+
"platform_default"
|
|
3573
|
+
],
|
|
3574
|
+
"title": "EnvironmentSource",
|
|
3575
|
+
"type": "string"
|
|
3576
|
+
},
|
|
3577
|
+
"EnvironmentsListResponse": {
|
|
3578
|
+
"description": "The caller's saved environments.",
|
|
3579
|
+
"properties": {
|
|
3580
|
+
"environments": {
|
|
3581
|
+
"description": "Saved environments.",
|
|
3582
|
+
"items": {
|
|
3583
|
+
"$ref": "#/components/schemas/Environment"
|
|
3584
|
+
},
|
|
3585
|
+
"title": "Environments",
|
|
3586
|
+
"type": "array"
|
|
3587
|
+
}
|
|
3588
|
+
},
|
|
3589
|
+
"required": [
|
|
3590
|
+
"environments"
|
|
3591
|
+
],
|
|
3592
|
+
"title": "EnvironmentsListResponse",
|
|
3593
|
+
"type": "object"
|
|
3594
|
+
},
|
|
3595
|
+
"ErrorInfo": {
|
|
3596
|
+
"properties": {
|
|
3597
|
+
"code": {
|
|
3598
|
+
"description": "Stable machine-readable error code. Open vocabulary \u2014 handle unknown codes by HTTP status. Known values: account_blocked, conflict, contact_email_required, failed_dependency, file_quota_exceeded, forbidden, internal_error, invalid_request, not_found, rate_limit_exceeded, rate_limited, review_in_flight, session_closed, session_ephemeral_trigger, session_finished, session_harness_single_turn, session_mention_surface, session_non_interactive, unauthorized, unavailable.",
|
|
3599
|
+
"title": "Code",
|
|
3600
|
+
"type": "string"
|
|
3601
|
+
},
|
|
3602
|
+
"message": {
|
|
3603
|
+
"description": "Human-readable explanation. Wording may change at any time; switch on `code`, never on this text.",
|
|
3604
|
+
"title": "Message",
|
|
3605
|
+
"type": "string"
|
|
3606
|
+
},
|
|
3607
|
+
"request_id": {
|
|
3608
|
+
"anyOf": [
|
|
3609
|
+
{
|
|
3610
|
+
"type": "string"
|
|
3611
|
+
},
|
|
3612
|
+
{
|
|
3613
|
+
"type": "null"
|
|
3614
|
+
}
|
|
3615
|
+
],
|
|
3616
|
+
"description": "Present on internal server errors: quote it when contacting support to identify the exact failure.",
|
|
3617
|
+
"title": "Request Id"
|
|
3618
|
+
}
|
|
3619
|
+
},
|
|
3620
|
+
"required": [
|
|
3621
|
+
"code",
|
|
3622
|
+
"message"
|
|
3623
|
+
],
|
|
3624
|
+
"title": "ErrorInfo",
|
|
3625
|
+
"type": "object"
|
|
3626
|
+
},
|
|
3627
|
+
"ErrorResponse": {
|
|
3628
|
+
"description": "The error envelope every /v1 error returns.",
|
|
3629
|
+
"properties": {
|
|
3630
|
+
"error": {
|
|
3631
|
+
"$ref": "#/components/schemas/ErrorInfo"
|
|
3632
|
+
}
|
|
3633
|
+
},
|
|
3634
|
+
"required": [
|
|
3635
|
+
"error"
|
|
3636
|
+
],
|
|
3637
|
+
"title": "ErrorResponse",
|
|
3638
|
+
"type": "object"
|
|
3639
|
+
},
|
|
3640
|
+
"ExecutionStatus": {
|
|
3641
|
+
"description": "Per-execution status ladder (was AgentProcessStatus). Distinct from the\nsession's durable `session_state` and from `agent_sessions.status`, which\nremains the atomic claim/dispatch guard.",
|
|
3642
|
+
"enum": [
|
|
3643
|
+
"running",
|
|
3644
|
+
"failed",
|
|
3645
|
+
"done"
|
|
3646
|
+
],
|
|
3647
|
+
"title": "ExecutionStatus",
|
|
3648
|
+
"type": "string"
|
|
3415
3649
|
},
|
|
3416
3650
|
"File": {
|
|
3417
3651
|
"description": "A file's metadata \u2014 the file itself is fetched via a separate\ndownload URL.",
|
|
@@ -5630,33 +5864,6 @@
|
|
|
5630
5864
|
"title": "PullRequestsTotals",
|
|
5631
5865
|
"type": "object"
|
|
5632
5866
|
},
|
|
5633
|
-
"PutAgentDefaultRequest": {
|
|
5634
|
-
"description": "Parameters for setting a default agent config, at either the account\nor the repository level.",
|
|
5635
|
-
"properties": {
|
|
5636
|
-
"config_id": {
|
|
5637
|
-
"description": "The config to make the default: a config id, or the agent's customer-unique `ellipsis.name`.",
|
|
5638
|
-
"title": "Config Id",
|
|
5639
|
-
"type": "string"
|
|
5640
|
-
},
|
|
5641
|
-
"repository": {
|
|
5642
|
-
"anyOf": [
|
|
5643
|
-
{
|
|
5644
|
-
"type": "string"
|
|
5645
|
-
},
|
|
5646
|
-
{
|
|
5647
|
-
"type": "null"
|
|
5648
|
-
}
|
|
5649
|
-
],
|
|
5650
|
-
"description": "The rung to set: \"owner/name\" for a repo default; omit to set the account default. Unlike session start's silent ignore, an unknown or foreign repo here is a 404.",
|
|
5651
|
-
"title": "Repository"
|
|
5652
|
-
}
|
|
5653
|
-
},
|
|
5654
|
-
"required": [
|
|
5655
|
-
"config_id"
|
|
5656
|
-
],
|
|
5657
|
-
"title": "PutAgentDefaultRequest",
|
|
5658
|
-
"type": "object"
|
|
5659
|
-
},
|
|
5660
5867
|
"PutSecretsRequest": {
|
|
5661
5868
|
"description": "Store secrets for the account's sandboxes. Each secret is upserted by\nname: existing names are overwritten.",
|
|
5662
5869
|
"properties": {
|
|
@@ -6130,64 +6337,8 @@
|
|
|
6130
6337
|
"title": "RecordSource",
|
|
6131
6338
|
"type": "string"
|
|
6132
6339
|
},
|
|
6133
|
-
"
|
|
6134
|
-
"description": "
|
|
6135
|
-
"properties": {
|
|
6136
|
-
"config_id": {
|
|
6137
|
-
"anyOf": [
|
|
6138
|
-
{
|
|
6139
|
-
"type": "string"
|
|
6140
|
-
},
|
|
6141
|
-
{
|
|
6142
|
-
"type": "null"
|
|
6143
|
-
}
|
|
6144
|
-
],
|
|
6145
|
-
"description": "A saved config to replay against. By default the original run's frozen config snapshot is reused.",
|
|
6146
|
-
"title": "Config Id"
|
|
6147
|
-
},
|
|
6148
|
-
"config_override": {
|
|
6149
|
-
"anyOf": [
|
|
6150
|
-
{
|
|
6151
|
-
"additionalProperties": true,
|
|
6152
|
-
"type": "object"
|
|
6153
|
-
},
|
|
6154
|
-
{
|
|
6155
|
-
"type": "null"
|
|
6156
|
-
}
|
|
6157
|
-
],
|
|
6158
|
-
"description": "Optional partial-config override merged onto the chosen config and re-validated \u2014 e.g. {\"claude\": {\"model\": \"claude-opus-4-8\"}} to replay the run on a different model, or {\"budget\": {\"session\": 5.0}} to raise its budget. Mutually exclusive with config_override_yaml.",
|
|
6159
|
-
"title": "Config Override"
|
|
6160
|
-
},
|
|
6161
|
-
"config_override_yaml": {
|
|
6162
|
-
"anyOf": [
|
|
6163
|
-
{
|
|
6164
|
-
"type": "string"
|
|
6165
|
-
},
|
|
6166
|
-
{
|
|
6167
|
-
"type": "null"
|
|
6168
|
-
}
|
|
6169
|
-
],
|
|
6170
|
-
"description": "The same partial-config override as a YAML/JSON string (e.g. read from a file). Mutually exclusive with config_override.",
|
|
6171
|
-
"title": "Config Override Yaml"
|
|
6172
|
-
},
|
|
6173
|
-
"prompt": {
|
|
6174
|
-
"anyOf": [
|
|
6175
|
-
{
|
|
6176
|
-
"type": "string"
|
|
6177
|
-
},
|
|
6178
|
-
{
|
|
6179
|
-
"type": "null"
|
|
6180
|
-
}
|
|
6181
|
-
],
|
|
6182
|
-
"description": "Per-run instructions. Omit to inherit the original run's prompt (a bare replay re-runs the same instructions); pass \"\" to clear it.",
|
|
6183
|
-
"title": "Prompt"
|
|
6184
|
-
}
|
|
6185
|
-
},
|
|
6186
|
-
"title": "ReplayAgentSessionRequest",
|
|
6187
|
-
"type": "object"
|
|
6188
|
-
},
|
|
6189
|
-
"RepoFacet": {
|
|
6190
|
-
"description": "A repository filter option, counted over the unfiltered window so\noptions never vanish when filters are applied.",
|
|
6340
|
+
"RepoFacet": {
|
|
6341
|
+
"description": "A repository filter option, counted over the unfiltered window so\noptions never vanish when filters are applied.",
|
|
6191
6342
|
"properties": {
|
|
6192
6343
|
"prs": {
|
|
6193
6344
|
"description": "Unfiltered pull-request count for this repository in the window.",
|
|
@@ -6295,6 +6446,7 @@
|
|
|
6295
6446
|
"reviews",
|
|
6296
6447
|
"configs",
|
|
6297
6448
|
"defaults",
|
|
6449
|
+
"environments",
|
|
6298
6450
|
"secrets",
|
|
6299
6451
|
"templates",
|
|
6300
6452
|
"integrations",
|
|
@@ -8507,6 +8659,10 @@
|
|
|
8507
8659
|
"title": "Created At",
|
|
8508
8660
|
"type": "string"
|
|
8509
8661
|
},
|
|
8662
|
+
"environment": {
|
|
8663
|
+
"$ref": "#/components/schemas/SessionEnvironment",
|
|
8664
|
+
"description": "The environment the session resolved: the saved environment's id and how it was chosen. The environment's frozen body is inside agent.config.environment."
|
|
8665
|
+
},
|
|
8510
8666
|
"exit_status": {
|
|
8511
8667
|
"anyOf": [
|
|
8512
8668
|
{
|
|
@@ -8814,6 +8970,55 @@
|
|
|
8814
8970
|
"title": "SessionCost",
|
|
8815
8971
|
"type": "object"
|
|
8816
8972
|
},
|
|
8973
|
+
"SessionDefaults": {
|
|
8974
|
+
"description": "The account-wide session defaults.",
|
|
8975
|
+
"properties": {
|
|
8976
|
+
"model": {
|
|
8977
|
+
"anyOf": [
|
|
8978
|
+
{
|
|
8979
|
+
"type": "string"
|
|
8980
|
+
},
|
|
8981
|
+
{
|
|
8982
|
+
"type": "null"
|
|
8983
|
+
}
|
|
8984
|
+
],
|
|
8985
|
+
"description": "Canonical model id every session falls back to when neither the request nor its agent config names one, or null when unset (sessions then run the platform default).",
|
|
8986
|
+
"title": "Model"
|
|
8987
|
+
}
|
|
8988
|
+
},
|
|
8989
|
+
"title": "SessionDefaults",
|
|
8990
|
+
"type": "object"
|
|
8991
|
+
},
|
|
8992
|
+
"SessionEnvironment": {
|
|
8993
|
+
"description": "The environment this session resolved: which saved environment (as it\nexists now) and how it was chosen. The environment's frozen BODY rides\ninside `agent.config.environment` \u2014 substitution happens before the config\nsnapshot freezes \u2014 so this object is provenance, not payload.",
|
|
8994
|
+
"properties": {
|
|
8995
|
+
"environment_id": {
|
|
8996
|
+
"anyOf": [
|
|
8997
|
+
{
|
|
8998
|
+
"type": "string"
|
|
8999
|
+
},
|
|
9000
|
+
{
|
|
9001
|
+
"type": "null"
|
|
9002
|
+
}
|
|
9003
|
+
],
|
|
9004
|
+
"description": "Identifier of the saved environment the session's config resolved. Null for an inline environment block or the built-in basic sandbox.",
|
|
9005
|
+
"title": "Environment Id"
|
|
9006
|
+
},
|
|
9007
|
+
"source": {
|
|
9008
|
+
"anyOf": [
|
|
9009
|
+
{
|
|
9010
|
+
"$ref": "#/components/schemas/EnvironmentSource"
|
|
9011
|
+
},
|
|
9012
|
+
{
|
|
9013
|
+
"type": "null"
|
|
9014
|
+
}
|
|
9015
|
+
],
|
|
9016
|
+
"description": "How the environment was chosen (request, agent_config, repo_default, account_default, platform_default). Null when the config carried its own inline environment."
|
|
9017
|
+
}
|
|
9018
|
+
},
|
|
9019
|
+
"title": "SessionEnvironment",
|
|
9020
|
+
"type": "object"
|
|
9021
|
+
},
|
|
8817
9022
|
"SessionExecution": {
|
|
8818
9023
|
"description": "One runtime attempt of a session \u2014 the initial start, a cold wake of a\ndurable conversation, or an infrastructure retry \u2014 including the launch\ncontext the model was actually given.",
|
|
8819
9024
|
"properties": {
|
|
@@ -10007,67 +10212,72 @@
|
|
|
10007
10212
|
"type": "object"
|
|
10008
10213
|
},
|
|
10009
10214
|
"StartAgentSessionRequest": {
|
|
10010
|
-
"
|
|
10215
|
+
"additionalProperties": false,
|
|
10216
|
+
"description": "Parameters for starting a new agent session: an optional base config\npointer, the message fields, and any AgentConfig keys to patch on top.",
|
|
10011
10217
|
"properties": {
|
|
10012
|
-
"
|
|
10218
|
+
"budget": {
|
|
10013
10219
|
"anyOf": [
|
|
10014
10220
|
{
|
|
10015
|
-
"$ref": "#/components/schemas/
|
|
10221
|
+
"$ref": "#/components/schemas/AgentConfigBudget"
|
|
10016
10222
|
},
|
|
10017
10223
|
{
|
|
10018
10224
|
"type": "null"
|
|
10019
10225
|
}
|
|
10020
10226
|
],
|
|
10021
|
-
"description": "
|
|
10227
|
+
"description": "The session's spend limits, e.g. {\"session\": 5.0}."
|
|
10022
10228
|
},
|
|
10023
|
-
"
|
|
10229
|
+
"claude": {
|
|
10024
10230
|
"anyOf": [
|
|
10025
10231
|
{
|
|
10026
|
-
"
|
|
10232
|
+
"$ref": "#/components/schemas/AgentConfigClaude"
|
|
10027
10233
|
},
|
|
10028
10234
|
{
|
|
10029
10235
|
"type": "null"
|
|
10030
10236
|
}
|
|
10031
10237
|
],
|
|
10032
|
-
"description": "
|
|
10033
|
-
"title": "Config Id"
|
|
10238
|
+
"description": "The Claude-harness block: `{\"model\": ...}` to pick this session's model, plus system/effort/fallback_model/max_turns/settings."
|
|
10034
10239
|
},
|
|
10035
|
-
"
|
|
10240
|
+
"codex": {
|
|
10036
10241
|
"anyOf": [
|
|
10037
10242
|
{
|
|
10038
|
-
"
|
|
10039
|
-
"type": "object"
|
|
10243
|
+
"$ref": "#/components/schemas/AgentConfigCodex"
|
|
10040
10244
|
},
|
|
10041
10245
|
{
|
|
10042
10246
|
"type": "null"
|
|
10043
10247
|
}
|
|
10044
10248
|
],
|
|
10045
|
-
"description": "
|
|
10046
|
-
|
|
10249
|
+
"description": "The Codex-harness block. Its presence on the EFFECTIVE config selects the Codex harness, exactly as in a saved config."
|
|
10250
|
+
},
|
|
10251
|
+
"ellipsis": {
|
|
10252
|
+
"$ref": "#/components/schemas/StartSessionEllipsis",
|
|
10253
|
+
"description": "Platform housekeeping: metadata, interactive, force_rebuild."
|
|
10047
10254
|
},
|
|
10048
|
-
"
|
|
10255
|
+
"environment": {
|
|
10049
10256
|
"anyOf": [
|
|
10050
10257
|
{
|
|
10051
10258
|
"type": "string"
|
|
10052
10259
|
},
|
|
10260
|
+
{
|
|
10261
|
+
"$ref": "#/components/schemas/AgentConfigEnvironment"
|
|
10262
|
+
},
|
|
10053
10263
|
{
|
|
10054
10264
|
"type": "null"
|
|
10055
10265
|
}
|
|
10056
10266
|
],
|
|
10057
|
-
"description": "
|
|
10058
|
-
"title": "
|
|
10059
|
-
},
|
|
10060
|
-
"force_rebuild": {
|
|
10061
|
-
"default": false,
|
|
10062
|
-
"description": "Skip the image cache for this session's initial provision: a fresh full build whose snapshot then refreshes the cache for later runs. A wake of a durable session provisions through the cache as usual. The CLI's `--rebuild`.",
|
|
10063
|
-
"title": "Force Rebuild",
|
|
10064
|
-
"type": "boolean"
|
|
10267
|
+
"description": "Where the session runs. A STRING (a saved environment's `env_...` id or name) re-picks that environment wholesale \u2014 it beats the base config's own reference. An OBJECT deep-merges onto the resolved environment (repositories merge by identity, see above).",
|
|
10268
|
+
"title": "Environment"
|
|
10065
10269
|
},
|
|
10066
|
-
"
|
|
10067
|
-
"
|
|
10068
|
-
|
|
10069
|
-
|
|
10070
|
-
|
|
10270
|
+
"from_config_id": {
|
|
10271
|
+
"anyOf": [
|
|
10272
|
+
{
|
|
10273
|
+
"type": "string"
|
|
10274
|
+
},
|
|
10275
|
+
{
|
|
10276
|
+
"type": "null"
|
|
10277
|
+
}
|
|
10278
|
+
],
|
|
10279
|
+
"description": "The saved agent config to use as this session's base: its id, or the agent's customer-unique `ellipsis.name`. Omitted, the base is the bare ad-hoc config \u2014 an empty system prompt on the account's default model in the basic sandbox \u2014 so the request's own keys and prompt fully describe the run.",
|
|
10280
|
+
"title": "From Config Id"
|
|
10071
10281
|
},
|
|
10072
10282
|
"input": {
|
|
10073
10283
|
"anyOf": [
|
|
@@ -10082,28 +10292,29 @@
|
|
|
10082
10292
|
"description": "The typed payload for an agent that declares input.json_schema: validated against the effective config's schema (422 on mismatch), rendered into the session's initial message (the agent's input.message template, or a JSON block). Required when the agent declares a schema; rejected when it does not.",
|
|
10083
10293
|
"title": "Input"
|
|
10084
10294
|
},
|
|
10085
|
-
"
|
|
10086
|
-
"
|
|
10087
|
-
|
|
10088
|
-
|
|
10089
|
-
|
|
10090
|
-
|
|
10091
|
-
|
|
10092
|
-
|
|
10295
|
+
"output": {
|
|
10296
|
+
"anyOf": [
|
|
10297
|
+
{
|
|
10298
|
+
"$ref": "#/components/schemas/AgentConfigOutput"
|
|
10299
|
+
},
|
|
10300
|
+
{
|
|
10301
|
+
"type": "null"
|
|
10302
|
+
}
|
|
10303
|
+
],
|
|
10304
|
+
"description": "The structured-output exit contract for this session."
|
|
10093
10305
|
},
|
|
10094
|
-
"
|
|
10306
|
+
"permissions": {
|
|
10095
10307
|
"anyOf": [
|
|
10096
10308
|
{
|
|
10097
|
-
"
|
|
10309
|
+
"$ref": "#/components/schemas/AgentConfigPermissions"
|
|
10098
10310
|
},
|
|
10099
10311
|
{
|
|
10100
10312
|
"type": "null"
|
|
10101
10313
|
}
|
|
10102
10314
|
],
|
|
10103
|
-
"description": "
|
|
10104
|
-
"title": "Prompt"
|
|
10315
|
+
"description": "What the session may touch, per minted credential."
|
|
10105
10316
|
},
|
|
10106
|
-
"
|
|
10317
|
+
"prompt": {
|
|
10107
10318
|
"anyOf": [
|
|
10108
10319
|
{
|
|
10109
10320
|
"type": "string"
|
|
@@ -10112,20 +10323,23 @@
|
|
|
10112
10323
|
"type": "null"
|
|
10113
10324
|
}
|
|
10114
10325
|
],
|
|
10115
|
-
"description": "The
|
|
10116
|
-
"title": "
|
|
10326
|
+
"description": "The session's first message. Omit it and the session starts idle: the sandbox spins up, the agent waits at the prompt, and the first message you send opens turn 0.",
|
|
10327
|
+
"title": "Prompt"
|
|
10117
10328
|
},
|
|
10118
|
-
"
|
|
10329
|
+
"skills": {
|
|
10119
10330
|
"anyOf": [
|
|
10120
10331
|
{
|
|
10121
|
-
"
|
|
10332
|
+
"items": {
|
|
10333
|
+
"$ref": "#/components/schemas/AgentConfigSkill"
|
|
10334
|
+
},
|
|
10335
|
+
"type": "array"
|
|
10122
10336
|
},
|
|
10123
10337
|
{
|
|
10124
10338
|
"type": "null"
|
|
10125
10339
|
}
|
|
10126
10340
|
],
|
|
10127
|
-
"description": "
|
|
10128
|
-
"title": "
|
|
10341
|
+
"description": "Config-declared skills; replaces the base config's list.",
|
|
10342
|
+
"title": "Skills"
|
|
10129
10343
|
}
|
|
10130
10344
|
},
|
|
10131
10345
|
"title": "StartAgentSessionRequest",
|
|
@@ -10176,6 +10390,35 @@
|
|
|
10176
10390
|
"title": "StartCliAuthResponse",
|
|
10177
10391
|
"type": "object"
|
|
10178
10392
|
},
|
|
10393
|
+
"StartSessionEllipsis": {
|
|
10394
|
+
"additionalProperties": false,
|
|
10395
|
+
"description": "Platform housekeeping for the session \u2014 the request-side `ellipsis`\nblock. Session-scoped: unlike a config file's `ellipsis` block it carries\nno `name`/`enabled` (those describe a saved agent, not a run) \u2014 and\nsending them here is a 422, not a silent drop.",
|
|
10396
|
+
"properties": {
|
|
10397
|
+
"force_rebuild": {
|
|
10398
|
+
"default": false,
|
|
10399
|
+
"description": "Skip the image cache for this session's initial provision: a fresh full build whose snapshot then refreshes the cache for later runs. A wake of a durable session provisions through the cache as usual. The CLI's `--rebuild`.",
|
|
10400
|
+
"title": "Force Rebuild",
|
|
10401
|
+
"type": "boolean"
|
|
10402
|
+
},
|
|
10403
|
+
"interactive": {
|
|
10404
|
+
"default": true,
|
|
10405
|
+
"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 (or input), since nothing can ever be sent to it later. Agents on the Codex harness are one-shot regardless.",
|
|
10406
|
+
"title": "Interactive",
|
|
10407
|
+
"type": "boolean"
|
|
10408
|
+
},
|
|
10409
|
+
"metadata": {
|
|
10410
|
+
"additionalProperties": {
|
|
10411
|
+
"type": "string"
|
|
10412
|
+
},
|
|
10413
|
+
"default": {},
|
|
10414
|
+
"description": "Arbitrary string key/value metadata stored on the session.",
|
|
10415
|
+
"title": "Metadata",
|
|
10416
|
+
"type": "object"
|
|
10417
|
+
}
|
|
10418
|
+
},
|
|
10419
|
+
"title": "StartSessionEllipsis",
|
|
10420
|
+
"type": "object"
|
|
10421
|
+
},
|
|
10179
10422
|
"TokensInfo": {
|
|
10180
10423
|
"additionalProperties": false,
|
|
10181
10424
|
"description": "Token/cost usage, per record (one API call's counts, aggregate fields at\ntheir zero defaults) or aggregated per execution/session\n(compute_spend_from_records derives num_turns and cost_usd).\n\nStrict on purpose: this is our own persisted schema, so an unknown key is a\nwriter bug (the num_turns=0 bug shipped because a Claude Code usage dict\nvalidated leniently against this model, silently zeroing every\nnon-overlapping field). Legacy keys were dropped from persisted blobs by\nthe 2026-07-26 tokens_info migration; per-model usage lives on\n`execution.model_usage` (CC's modelUsage, verbatim).",
|
|
@@ -10256,6 +10499,20 @@
|
|
|
10256
10499
|
"title": "UpdateAgentConfigRequest",
|
|
10257
10500
|
"type": "object"
|
|
10258
10501
|
},
|
|
10502
|
+
"UpdateEnvironmentRequest": {
|
|
10503
|
+
"description": "A replacement definition for an environment managed through the API.",
|
|
10504
|
+
"properties": {
|
|
10505
|
+
"environment": {
|
|
10506
|
+
"$ref": "#/components/schemas/EnvironmentConfig",
|
|
10507
|
+
"description": "The environment's new definition. Replaces the previous one wholesale \u2014 this is not a partial update."
|
|
10508
|
+
}
|
|
10509
|
+
},
|
|
10510
|
+
"required": [
|
|
10511
|
+
"environment"
|
|
10512
|
+
],
|
|
10513
|
+
"title": "UpdateEnvironmentRequest",
|
|
10514
|
+
"type": "object"
|
|
10515
|
+
},
|
|
10259
10516
|
"UsageDailyPoint": {
|
|
10260
10517
|
"description": "One day's usage: tokens split by type, and cost split into the four\nbilled categories. `tokens` is the sum of the four token types.",
|
|
10261
10518
|
"properties": {
|
|
@@ -10556,7 +10813,7 @@
|
|
|
10556
10813
|
"x-ellipsis-sdk-method": "agents.configs.list"
|
|
10557
10814
|
},
|
|
10558
10815
|
"post": {
|
|
10559
|
-
"description": "Create an agent config
|
|
10816
|
+
"description": "Create an agent config, managed through the API: no file, live\nimmediately. To put its definition in a repository instead, create\nit here and then POST /v1/agents/configs/{config_id}/link.\n\n409 when another live agent already holds the name.",
|
|
10560
10817
|
"operationId": "create_agent_config",
|
|
10561
10818
|
"parameters": [
|
|
10562
10819
|
{
|
|
@@ -10587,11 +10844,11 @@
|
|
|
10587
10844
|
"required": true
|
|
10588
10845
|
},
|
|
10589
10846
|
"responses": {
|
|
10590
|
-
"
|
|
10847
|
+
"201": {
|
|
10591
10848
|
"content": {
|
|
10592
10849
|
"application/json": {
|
|
10593
10850
|
"schema": {
|
|
10594
|
-
"$ref": "#/components/schemas/
|
|
10851
|
+
"$ref": "#/components/schemas/AgentConfigResponse"
|
|
10595
10852
|
}
|
|
10596
10853
|
}
|
|
10597
10854
|
},
|
|
@@ -10605,7 +10862,7 @@
|
|
|
10605
10862
|
}
|
|
10606
10863
|
}
|
|
10607
10864
|
},
|
|
10608
|
-
"description": "
|
|
10865
|
+
"description": "The config is invalid."
|
|
10609
10866
|
},
|
|
10610
10867
|
"401": {
|
|
10611
10868
|
"content": {
|
|
@@ -10627,16 +10884,6 @@
|
|
|
10627
10884
|
},
|
|
10628
10885
|
"description": "The credential may not perform this action, or the account is blocked."
|
|
10629
10886
|
},
|
|
10630
|
-
"404": {
|
|
10631
|
-
"content": {
|
|
10632
|
-
"application/json": {
|
|
10633
|
-
"schema": {
|
|
10634
|
-
"$ref": "#/components/schemas/ErrorResponse"
|
|
10635
|
-
}
|
|
10636
|
-
}
|
|
10637
|
-
},
|
|
10638
|
-
"description": "The template or repository was not found in your account."
|
|
10639
|
-
},
|
|
10640
10887
|
"409": {
|
|
10641
10888
|
"content": {
|
|
10642
10889
|
"application/json": {
|
|
@@ -10645,7 +10892,7 @@
|
|
|
10645
10892
|
}
|
|
10646
10893
|
}
|
|
10647
10894
|
},
|
|
10648
|
-
"description": "An agent with that name already exists
|
|
10895
|
+
"description": "An agent with that name already exists."
|
|
10649
10896
|
},
|
|
10650
10897
|
"422": {
|
|
10651
10898
|
"content": {
|
|
@@ -11214,29 +11461,11 @@
|
|
|
11214
11461
|
"x-ellipsis-sdk-method": "agents.configs.unlink"
|
|
11215
11462
|
}
|
|
11216
11463
|
},
|
|
11217
|
-
"/v1/agents/
|
|
11218
|
-
"
|
|
11219
|
-
"description": "
|
|
11220
|
-
"operationId": "
|
|
11464
|
+
"/v1/agents/templates": {
|
|
11465
|
+
"get": {
|
|
11466
|
+
"description": "List the built-in starter agent templates.\n\nBehind auth but not account-scoped \u2014 the data is static\nproduct content shared by the dashboard, landing site, and CLI.",
|
|
11467
|
+
"operationId": "list_agent_templates",
|
|
11221
11468
|
"parameters": [
|
|
11222
|
-
{
|
|
11223
|
-
"description": "Repo rung to clear (\"owner/name\"); omit to clear the account default.",
|
|
11224
|
-
"in": "query",
|
|
11225
|
-
"name": "repository",
|
|
11226
|
-
"required": false,
|
|
11227
|
-
"schema": {
|
|
11228
|
-
"anyOf": [
|
|
11229
|
-
{
|
|
11230
|
-
"type": "string"
|
|
11231
|
-
},
|
|
11232
|
-
{
|
|
11233
|
-
"type": "null"
|
|
11234
|
-
}
|
|
11235
|
-
],
|
|
11236
|
-
"description": "Repo rung to clear (\"owner/name\"); omit to clear the account default.",
|
|
11237
|
-
"title": "Repository"
|
|
11238
|
-
}
|
|
11239
|
-
},
|
|
11240
11469
|
{
|
|
11241
11470
|
"in": "header",
|
|
11242
11471
|
"name": "user-agent",
|
|
@@ -11255,20 +11484,17 @@
|
|
|
11255
11484
|
}
|
|
11256
11485
|
],
|
|
11257
11486
|
"responses": {
|
|
11258
|
-
"
|
|
11259
|
-
"description": "Successful Response"
|
|
11260
|
-
},
|
|
11261
|
-
"401": {
|
|
11487
|
+
"200": {
|
|
11262
11488
|
"content": {
|
|
11263
11489
|
"application/json": {
|
|
11264
11490
|
"schema": {
|
|
11265
|
-
"$ref": "#/components/schemas/
|
|
11491
|
+
"$ref": "#/components/schemas/AgentTemplatesListResponse"
|
|
11266
11492
|
}
|
|
11267
11493
|
}
|
|
11268
11494
|
},
|
|
11269
|
-
"description": "
|
|
11495
|
+
"description": "Successful Response"
|
|
11270
11496
|
},
|
|
11271
|
-
"
|
|
11497
|
+
"401": {
|
|
11272
11498
|
"content": {
|
|
11273
11499
|
"application/json": {
|
|
11274
11500
|
"schema": {
|
|
@@ -11276,9 +11502,9 @@
|
|
|
11276
11502
|
}
|
|
11277
11503
|
}
|
|
11278
11504
|
},
|
|
11279
|
-
"description": "The
|
|
11505
|
+
"description": "The bearer token is missing, invalid, or revoked."
|
|
11280
11506
|
},
|
|
11281
|
-
"
|
|
11507
|
+
"403": {
|
|
11282
11508
|
"content": {
|
|
11283
11509
|
"application/json": {
|
|
11284
11510
|
"schema": {
|
|
@@ -11286,7 +11512,7 @@
|
|
|
11286
11512
|
}
|
|
11287
11513
|
}
|
|
11288
11514
|
},
|
|
11289
|
-
"description": "
|
|
11515
|
+
"description": "The credential may not perform this action, or the account is blocked."
|
|
11290
11516
|
},
|
|
11291
11517
|
"422": {
|
|
11292
11518
|
"content": {
|
|
@@ -11304,16 +11530,28 @@
|
|
|
11304
11530
|
"HTTPBearer": []
|
|
11305
11531
|
}
|
|
11306
11532
|
],
|
|
11307
|
-
"summary": "
|
|
11533
|
+
"summary": "List Agent Templates",
|
|
11308
11534
|
"tags": [
|
|
11309
11535
|
"v1"
|
|
11310
11536
|
],
|
|
11311
|
-
"x-ellipsis-sdk-method": "agents.
|
|
11312
|
-
|
|
11537
|
+
"x-ellipsis-sdk-method": "agents.templates.list",
|
|
11538
|
+
"x-ellipsis-undocumented": true
|
|
11539
|
+
}
|
|
11540
|
+
},
|
|
11541
|
+
"/v1/agents/templates/{template_id}": {
|
|
11313
11542
|
"get": {
|
|
11314
|
-
"description": "
|
|
11315
|
-
"operationId": "
|
|
11543
|
+
"description": "Return one built-in agent template by slug.",
|
|
11544
|
+
"operationId": "get_agent_template",
|
|
11316
11545
|
"parameters": [
|
|
11546
|
+
{
|
|
11547
|
+
"in": "path",
|
|
11548
|
+
"name": "template_id",
|
|
11549
|
+
"required": true,
|
|
11550
|
+
"schema": {
|
|
11551
|
+
"title": "Template Id",
|
|
11552
|
+
"type": "string"
|
|
11553
|
+
}
|
|
11554
|
+
},
|
|
11317
11555
|
{
|
|
11318
11556
|
"in": "header",
|
|
11319
11557
|
"name": "user-agent",
|
|
@@ -11336,7 +11574,7 @@
|
|
|
11336
11574
|
"content": {
|
|
11337
11575
|
"application/json": {
|
|
11338
11576
|
"schema": {
|
|
11339
|
-
"$ref": "#/components/schemas/
|
|
11577
|
+
"$ref": "#/components/schemas/AgentTemplate"
|
|
11340
11578
|
}
|
|
11341
11579
|
}
|
|
11342
11580
|
},
|
|
@@ -11362,6 +11600,16 @@
|
|
|
11362
11600
|
},
|
|
11363
11601
|
"description": "The credential may not perform this action, or the account is blocked."
|
|
11364
11602
|
},
|
|
11603
|
+
"404": {
|
|
11604
|
+
"content": {
|
|
11605
|
+
"application/json": {
|
|
11606
|
+
"schema": {
|
|
11607
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
11608
|
+
}
|
|
11609
|
+
}
|
|
11610
|
+
},
|
|
11611
|
+
"description": "No such template."
|
|
11612
|
+
},
|
|
11365
11613
|
"422": {
|
|
11366
11614
|
"content": {
|
|
11367
11615
|
"application/json": {
|
|
@@ -11378,19 +11626,82 @@
|
|
|
11378
11626
|
"HTTPBearer": []
|
|
11379
11627
|
}
|
|
11380
11628
|
],
|
|
11381
|
-
"summary": "
|
|
11629
|
+
"summary": "Get Agent Template",
|
|
11382
11630
|
"tags": [
|
|
11383
11631
|
"v1"
|
|
11384
11632
|
],
|
|
11385
|
-
"x-ellipsis-sdk-method": "agents.
|
|
11386
|
-
|
|
11387
|
-
|
|
11388
|
-
|
|
11389
|
-
|
|
11633
|
+
"x-ellipsis-sdk-method": "agents.templates.get",
|
|
11634
|
+
"x-ellipsis-undocumented": true
|
|
11635
|
+
}
|
|
11636
|
+
},
|
|
11637
|
+
"/v1/alerts": {
|
|
11638
|
+
"get": {
|
|
11639
|
+
"description": "List budget alerts for the organization, newest first.\n\nOptionally filtered by status and source.\n\nAvailable to all credential types, so an agent can check \"is\nthis org near budget?\" mid-task.",
|
|
11640
|
+
"operationId": "list_alerts",
|
|
11390
11641
|
"parameters": [
|
|
11391
11642
|
{
|
|
11392
|
-
"in": "
|
|
11393
|
-
"name": "
|
|
11643
|
+
"in": "query",
|
|
11644
|
+
"name": "status",
|
|
11645
|
+
"required": false,
|
|
11646
|
+
"schema": {
|
|
11647
|
+
"anyOf": [
|
|
11648
|
+
{
|
|
11649
|
+
"$ref": "#/components/schemas/AlertStatus"
|
|
11650
|
+
},
|
|
11651
|
+
{
|
|
11652
|
+
"type": "null"
|
|
11653
|
+
}
|
|
11654
|
+
],
|
|
11655
|
+
"title": "Status"
|
|
11656
|
+
}
|
|
11657
|
+
},
|
|
11658
|
+
{
|
|
11659
|
+
"in": "query",
|
|
11660
|
+
"name": "source",
|
|
11661
|
+
"required": false,
|
|
11662
|
+
"schema": {
|
|
11663
|
+
"anyOf": [
|
|
11664
|
+
{
|
|
11665
|
+
"$ref": "#/components/schemas/AlertSource"
|
|
11666
|
+
},
|
|
11667
|
+
{
|
|
11668
|
+
"type": "null"
|
|
11669
|
+
}
|
|
11670
|
+
],
|
|
11671
|
+
"title": "Source"
|
|
11672
|
+
}
|
|
11673
|
+
},
|
|
11674
|
+
{
|
|
11675
|
+
"in": "query",
|
|
11676
|
+
"name": "limit",
|
|
11677
|
+
"required": false,
|
|
11678
|
+
"schema": {
|
|
11679
|
+
"default": 100,
|
|
11680
|
+
"maximum": 200,
|
|
11681
|
+
"minimum": 1,
|
|
11682
|
+
"title": "Limit",
|
|
11683
|
+
"type": "integer"
|
|
11684
|
+
}
|
|
11685
|
+
},
|
|
11686
|
+
{
|
|
11687
|
+
"in": "query",
|
|
11688
|
+
"name": "cursor",
|
|
11689
|
+
"required": false,
|
|
11690
|
+
"schema": {
|
|
11691
|
+
"anyOf": [
|
|
11692
|
+
{
|
|
11693
|
+
"type": "string"
|
|
11694
|
+
},
|
|
11695
|
+
{
|
|
11696
|
+
"type": "null"
|
|
11697
|
+
}
|
|
11698
|
+
],
|
|
11699
|
+
"title": "Cursor"
|
|
11700
|
+
}
|
|
11701
|
+
},
|
|
11702
|
+
{
|
|
11703
|
+
"in": "header",
|
|
11704
|
+
"name": "user-agent",
|
|
11394
11705
|
"required": false,
|
|
11395
11706
|
"schema": {
|
|
11396
11707
|
"anyOf": [
|
|
@@ -11405,37 +11716,17 @@
|
|
|
11405
11716
|
}
|
|
11406
11717
|
}
|
|
11407
11718
|
],
|
|
11408
|
-
"requestBody": {
|
|
11409
|
-
"content": {
|
|
11410
|
-
"application/json": {
|
|
11411
|
-
"schema": {
|
|
11412
|
-
"$ref": "#/components/schemas/PutAgentDefaultRequest"
|
|
11413
|
-
}
|
|
11414
|
-
}
|
|
11415
|
-
},
|
|
11416
|
-
"required": true
|
|
11417
|
-
},
|
|
11418
11719
|
"responses": {
|
|
11419
11720
|
"200": {
|
|
11420
11721
|
"content": {
|
|
11421
11722
|
"application/json": {
|
|
11422
11723
|
"schema": {
|
|
11423
|
-
"$ref": "#/components/schemas/
|
|
11724
|
+
"$ref": "#/components/schemas/AlertsListResponse"
|
|
11424
11725
|
}
|
|
11425
11726
|
}
|
|
11426
11727
|
},
|
|
11427
11728
|
"description": "Successful Response"
|
|
11428
11729
|
},
|
|
11429
|
-
"400": {
|
|
11430
|
-
"content": {
|
|
11431
|
-
"application/json": {
|
|
11432
|
-
"schema": {
|
|
11433
|
-
"$ref": "#/components/schemas/ErrorResponse"
|
|
11434
|
-
}
|
|
11435
|
-
}
|
|
11436
|
-
},
|
|
11437
|
-
"description": "The config is not eligible as a default: its pull request has not merged, or it is disabled."
|
|
11438
|
-
},
|
|
11439
11730
|
"401": {
|
|
11440
11731
|
"content": {
|
|
11441
11732
|
"application/json": {
|
|
@@ -11456,16 +11747,6 @@
|
|
|
11456
11747
|
},
|
|
11457
11748
|
"description": "The credential may not perform this action, or the account is blocked."
|
|
11458
11749
|
},
|
|
11459
|
-
"404": {
|
|
11460
|
-
"content": {
|
|
11461
|
-
"application/json": {
|
|
11462
|
-
"schema": {
|
|
11463
|
-
"$ref": "#/components/schemas/ErrorResponse"
|
|
11464
|
-
}
|
|
11465
|
-
}
|
|
11466
|
-
},
|
|
11467
|
-
"description": "The config or repository was not found in your account."
|
|
11468
|
-
},
|
|
11469
11750
|
"422": {
|
|
11470
11751
|
"content": {
|
|
11471
11752
|
"application/json": {
|
|
@@ -11482,18 +11763,28 @@
|
|
|
11482
11763
|
"HTTPBearer": []
|
|
11483
11764
|
}
|
|
11484
11765
|
],
|
|
11485
|
-
"summary": "
|
|
11766
|
+
"summary": "List Alerts",
|
|
11486
11767
|
"tags": [
|
|
11487
11768
|
"v1"
|
|
11488
11769
|
],
|
|
11489
|
-
"x-ellipsis-sdk-method": "
|
|
11770
|
+
"x-ellipsis-sdk-method": "alerts.list",
|
|
11771
|
+
"x-ellipsis-undocumented": true
|
|
11490
11772
|
}
|
|
11491
11773
|
},
|
|
11492
|
-
"/v1/
|
|
11774
|
+
"/v1/alerts/{alert_id}": {
|
|
11493
11775
|
"get": {
|
|
11494
|
-
"description": "
|
|
11495
|
-
"operationId": "
|
|
11776
|
+
"description": "Return one alert by id.\n\n404 if it doesn't exist or belongs to another organization.",
|
|
11777
|
+
"operationId": "get_alert",
|
|
11496
11778
|
"parameters": [
|
|
11779
|
+
{
|
|
11780
|
+
"in": "path",
|
|
11781
|
+
"name": "alert_id",
|
|
11782
|
+
"required": true,
|
|
11783
|
+
"schema": {
|
|
11784
|
+
"title": "Alert Id",
|
|
11785
|
+
"type": "string"
|
|
11786
|
+
}
|
|
11787
|
+
},
|
|
11497
11788
|
{
|
|
11498
11789
|
"in": "header",
|
|
11499
11790
|
"name": "user-agent",
|
|
@@ -11516,7 +11807,7 @@
|
|
|
11516
11807
|
"content": {
|
|
11517
11808
|
"application/json": {
|
|
11518
11809
|
"schema": {
|
|
11519
|
-
"$ref": "#/components/schemas/
|
|
11810
|
+
"$ref": "#/components/schemas/AlertResponse"
|
|
11520
11811
|
}
|
|
11521
11812
|
}
|
|
11522
11813
|
},
|
|
@@ -11542,6 +11833,16 @@
|
|
|
11542
11833
|
},
|
|
11543
11834
|
"description": "The credential may not perform this action, or the account is blocked."
|
|
11544
11835
|
},
|
|
11836
|
+
"404": {
|
|
11837
|
+
"content": {
|
|
11838
|
+
"application/json": {
|
|
11839
|
+
"schema": {
|
|
11840
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
11841
|
+
}
|
|
11842
|
+
}
|
|
11843
|
+
},
|
|
11844
|
+
"description": "No such alert in your account."
|
|
11845
|
+
},
|
|
11545
11846
|
"422": {
|
|
11546
11847
|
"content": {
|
|
11547
11848
|
"application/json": {
|
|
@@ -11558,24 +11859,25 @@
|
|
|
11558
11859
|
"HTTPBearer": []
|
|
11559
11860
|
}
|
|
11560
11861
|
],
|
|
11561
|
-
"summary": "
|
|
11862
|
+
"summary": "Get Alert",
|
|
11562
11863
|
"tags": [
|
|
11563
11864
|
"v1"
|
|
11564
11865
|
],
|
|
11565
|
-
"x-ellipsis-sdk-method": "
|
|
11866
|
+
"x-ellipsis-sdk-method": "alerts.get",
|
|
11867
|
+
"x-ellipsis-undocumented": true
|
|
11566
11868
|
}
|
|
11567
11869
|
},
|
|
11568
|
-
"/v1/
|
|
11569
|
-
"
|
|
11570
|
-
"description": "
|
|
11571
|
-
"operationId": "
|
|
11870
|
+
"/v1/alerts/{alert_id}/dismiss": {
|
|
11871
|
+
"post": {
|
|
11872
|
+
"description": "Dismiss an open alert and return it.\n\n409 when the alert is not open; 404 when it doesn't exist.",
|
|
11873
|
+
"operationId": "dismiss_alert",
|
|
11572
11874
|
"parameters": [
|
|
11573
11875
|
{
|
|
11574
11876
|
"in": "path",
|
|
11575
|
-
"name": "
|
|
11877
|
+
"name": "alert_id",
|
|
11576
11878
|
"required": true,
|
|
11577
11879
|
"schema": {
|
|
11578
|
-
"title": "
|
|
11880
|
+
"title": "Alert Id",
|
|
11579
11881
|
"type": "string"
|
|
11580
11882
|
}
|
|
11581
11883
|
},
|
|
@@ -11601,7 +11903,7 @@
|
|
|
11601
11903
|
"content": {
|
|
11602
11904
|
"application/json": {
|
|
11603
11905
|
"schema": {
|
|
11604
|
-
"$ref": "#/components/schemas/
|
|
11906
|
+
"$ref": "#/components/schemas/AlertResponse"
|
|
11605
11907
|
}
|
|
11606
11908
|
}
|
|
11607
11909
|
},
|
|
@@ -11635,7 +11937,17 @@
|
|
|
11635
11937
|
}
|
|
11636
11938
|
}
|
|
11637
11939
|
},
|
|
11638
|
-
"description": "No such
|
|
11940
|
+
"description": "No such alert in your account."
|
|
11941
|
+
},
|
|
11942
|
+
"409": {
|
|
11943
|
+
"content": {
|
|
11944
|
+
"application/json": {
|
|
11945
|
+
"schema": {
|
|
11946
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
11947
|
+
}
|
|
11948
|
+
}
|
|
11949
|
+
},
|
|
11950
|
+
"description": "The alert is not open."
|
|
11639
11951
|
},
|
|
11640
11952
|
"422": {
|
|
11641
11953
|
"content": {
|
|
@@ -11653,76 +11965,140 @@
|
|
|
11653
11965
|
"HTTPBearer": []
|
|
11654
11966
|
}
|
|
11655
11967
|
],
|
|
11656
|
-
"summary": "
|
|
11968
|
+
"summary": "Dismiss Alert",
|
|
11657
11969
|
"tags": [
|
|
11658
11970
|
"v1"
|
|
11659
11971
|
],
|
|
11660
|
-
"x-ellipsis-sdk-method": "
|
|
11972
|
+
"x-ellipsis-sdk-method": "alerts.dismiss",
|
|
11973
|
+
"x-ellipsis-undocumented": true
|
|
11661
11974
|
}
|
|
11662
11975
|
},
|
|
11663
|
-
"/v1/
|
|
11976
|
+
"/v1/analytics/metrics": {
|
|
11664
11977
|
"get": {
|
|
11665
|
-
"description": "
|
|
11666
|
-
"operationId": "
|
|
11978
|
+
"description": "Return PR and review analytics metrics.\n\nThe same data as the analytics dashboard.\n\nWindowing: pass explicit start/end, or days (default: the last\n30 days). account_type in all|user|bot scopes the authors (bot =\nthe apps/agents). Available to all credential types: the\nresponses expose the organization's own GitHub PR/review activity,\nno secrets.",
|
|
11979
|
+
"operationId": "get_analytics_metrics",
|
|
11667
11980
|
"parameters": [
|
|
11668
11981
|
{
|
|
11669
11982
|
"in": "query",
|
|
11670
|
-
"name": "
|
|
11983
|
+
"name": "days",
|
|
11671
11984
|
"required": false,
|
|
11672
11985
|
"schema": {
|
|
11673
11986
|
"anyOf": [
|
|
11674
11987
|
{
|
|
11675
|
-
"
|
|
11988
|
+
"type": "integer"
|
|
11676
11989
|
},
|
|
11677
11990
|
{
|
|
11678
11991
|
"type": "null"
|
|
11679
11992
|
}
|
|
11680
11993
|
],
|
|
11681
|
-
"title": "
|
|
11994
|
+
"title": "Days"
|
|
11682
11995
|
}
|
|
11683
11996
|
},
|
|
11684
11997
|
{
|
|
11685
11998
|
"in": "query",
|
|
11686
|
-
"name": "
|
|
11999
|
+
"name": "start",
|
|
11687
12000
|
"required": false,
|
|
11688
12001
|
"schema": {
|
|
11689
12002
|
"anyOf": [
|
|
11690
12003
|
{
|
|
11691
|
-
"
|
|
12004
|
+
"format": "date-time",
|
|
12005
|
+
"type": "string"
|
|
11692
12006
|
},
|
|
11693
12007
|
{
|
|
11694
12008
|
"type": "null"
|
|
11695
12009
|
}
|
|
11696
12010
|
],
|
|
11697
|
-
"title": "
|
|
12011
|
+
"title": "Start"
|
|
11698
12012
|
}
|
|
11699
12013
|
},
|
|
11700
12014
|
{
|
|
11701
12015
|
"in": "query",
|
|
11702
|
-
"name": "
|
|
12016
|
+
"name": "end",
|
|
11703
12017
|
"required": false,
|
|
11704
12018
|
"schema": {
|
|
11705
|
-
"
|
|
11706
|
-
|
|
11707
|
-
|
|
11708
|
-
|
|
11709
|
-
|
|
12019
|
+
"anyOf": [
|
|
12020
|
+
{
|
|
12021
|
+
"format": "date-time",
|
|
12022
|
+
"type": "string"
|
|
12023
|
+
},
|
|
12024
|
+
{
|
|
12025
|
+
"type": "null"
|
|
12026
|
+
}
|
|
12027
|
+
],
|
|
12028
|
+
"title": "End"
|
|
11710
12029
|
}
|
|
11711
12030
|
},
|
|
11712
12031
|
{
|
|
12032
|
+
"description": "Filter to repositories by \"owner/name\".",
|
|
11713
12033
|
"in": "query",
|
|
11714
|
-
"name": "
|
|
12034
|
+
"name": "repo",
|
|
11715
12035
|
"required": false,
|
|
11716
12036
|
"schema": {
|
|
11717
12037
|
"anyOf": [
|
|
11718
12038
|
{
|
|
11719
|
-
"
|
|
12039
|
+
"items": {
|
|
12040
|
+
"type": "string"
|
|
12041
|
+
},
|
|
12042
|
+
"type": "array"
|
|
11720
12043
|
},
|
|
11721
12044
|
{
|
|
11722
12045
|
"type": "null"
|
|
11723
12046
|
}
|
|
11724
12047
|
],
|
|
11725
|
-
"
|
|
12048
|
+
"description": "Filter to repositories by \"owner/name\".",
|
|
12049
|
+
"title": "Repo"
|
|
12050
|
+
}
|
|
12051
|
+
},
|
|
12052
|
+
{
|
|
12053
|
+
"description": "Filter by PR-author login(s).",
|
|
12054
|
+
"in": "query",
|
|
12055
|
+
"name": "author",
|
|
12056
|
+
"required": false,
|
|
12057
|
+
"schema": {
|
|
12058
|
+
"anyOf": [
|
|
12059
|
+
{
|
|
12060
|
+
"items": {
|
|
12061
|
+
"type": "string"
|
|
12062
|
+
},
|
|
12063
|
+
"type": "array"
|
|
12064
|
+
},
|
|
12065
|
+
{
|
|
12066
|
+
"type": "null"
|
|
12067
|
+
}
|
|
12068
|
+
],
|
|
12069
|
+
"description": "Filter by PR-author login(s).",
|
|
12070
|
+
"title": "Author"
|
|
12071
|
+
}
|
|
12072
|
+
},
|
|
12073
|
+
{
|
|
12074
|
+
"in": "query",
|
|
12075
|
+
"name": "account_type",
|
|
12076
|
+
"required": false,
|
|
12077
|
+
"schema": {
|
|
12078
|
+
"default": "all",
|
|
12079
|
+
"title": "Account Type",
|
|
12080
|
+
"type": "string"
|
|
12081
|
+
}
|
|
12082
|
+
},
|
|
12083
|
+
{
|
|
12084
|
+
"description": "Filter by parent-PR status (open|draft|merged|closed).",
|
|
12085
|
+
"in": "query",
|
|
12086
|
+
"name": "status",
|
|
12087
|
+
"required": false,
|
|
12088
|
+
"schema": {
|
|
12089
|
+
"anyOf": [
|
|
12090
|
+
{
|
|
12091
|
+
"items": {
|
|
12092
|
+
"type": "string"
|
|
12093
|
+
},
|
|
12094
|
+
"type": "array"
|
|
12095
|
+
},
|
|
12096
|
+
{
|
|
12097
|
+
"type": "null"
|
|
12098
|
+
}
|
|
12099
|
+
],
|
|
12100
|
+
"description": "Filter by parent-PR status (open|draft|merged|closed).",
|
|
12101
|
+
"title": "Status"
|
|
11726
12102
|
}
|
|
11727
12103
|
},
|
|
11728
12104
|
{
|
|
@@ -11747,13 +12123,13 @@
|
|
|
11747
12123
|
"content": {
|
|
11748
12124
|
"application/json": {
|
|
11749
12125
|
"schema": {
|
|
11750
|
-
"$ref": "#/components/schemas/
|
|
12126
|
+
"$ref": "#/components/schemas/GetAnalyticsMetricsResponse"
|
|
11751
12127
|
}
|
|
11752
12128
|
}
|
|
11753
12129
|
},
|
|
11754
12130
|
"description": "Successful Response"
|
|
11755
12131
|
},
|
|
11756
|
-
"
|
|
12132
|
+
"400": {
|
|
11757
12133
|
"content": {
|
|
11758
12134
|
"application/json": {
|
|
11759
12135
|
"schema": {
|
|
@@ -11761,9 +12137,9 @@
|
|
|
11761
12137
|
}
|
|
11762
12138
|
}
|
|
11763
12139
|
},
|
|
11764
|
-
"description": "The
|
|
12140
|
+
"description": "The time window is invalid: days combined with start, a non-positive days, or end not after start."
|
|
11765
12141
|
},
|
|
11766
|
-
"
|
|
12142
|
+
"401": {
|
|
11767
12143
|
"content": {
|
|
11768
12144
|
"application/json": {
|
|
11769
12145
|
"schema": {
|
|
@@ -11771,7 +12147,17 @@
|
|
|
11771
12147
|
}
|
|
11772
12148
|
}
|
|
11773
12149
|
},
|
|
11774
|
-
"description": "The
|
|
12150
|
+
"description": "The bearer token is missing, invalid, or revoked."
|
|
12151
|
+
},
|
|
12152
|
+
"403": {
|
|
12153
|
+
"content": {
|
|
12154
|
+
"application/json": {
|
|
12155
|
+
"schema": {
|
|
12156
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
12157
|
+
}
|
|
12158
|
+
}
|
|
12159
|
+
},
|
|
12160
|
+
"description": "The credential may not perform this action, or the account is blocked."
|
|
11775
12161
|
},
|
|
11776
12162
|
"422": {
|
|
11777
12163
|
"content": {
|
|
@@ -11789,120 +12175,143 @@
|
|
|
11789
12175
|
"HTTPBearer": []
|
|
11790
12176
|
}
|
|
11791
12177
|
],
|
|
11792
|
-
"summary": "
|
|
12178
|
+
"summary": "Get Analytics Metrics",
|
|
11793
12179
|
"tags": [
|
|
11794
12180
|
"v1"
|
|
11795
12181
|
],
|
|
11796
|
-
"x-ellipsis-sdk-method": "
|
|
12182
|
+
"x-ellipsis-sdk-method": "analytics.metrics",
|
|
12183
|
+
"x-ellipsis-undocumented": true
|
|
11797
12184
|
}
|
|
11798
12185
|
},
|
|
11799
|
-
"/v1/
|
|
12186
|
+
"/v1/analytics/pull-requests": {
|
|
11800
12187
|
"get": {
|
|
11801
|
-
"description": "Return
|
|
11802
|
-
"operationId": "
|
|
12188
|
+
"description": "Return pull-request analytics.\n\nWindowing: pass explicit start/end, or days (default: the last\n30 days).",
|
|
12189
|
+
"operationId": "get_analytics_pull_requests",
|
|
11803
12190
|
"parameters": [
|
|
11804
12191
|
{
|
|
11805
|
-
"in": "
|
|
11806
|
-
"name": "
|
|
11807
|
-
"required":
|
|
12192
|
+
"in": "query",
|
|
12193
|
+
"name": "days",
|
|
12194
|
+
"required": false,
|
|
11808
12195
|
"schema": {
|
|
11809
|
-
"
|
|
11810
|
-
|
|
12196
|
+
"anyOf": [
|
|
12197
|
+
{
|
|
12198
|
+
"type": "integer"
|
|
12199
|
+
},
|
|
12200
|
+
{
|
|
12201
|
+
"type": "null"
|
|
12202
|
+
}
|
|
12203
|
+
],
|
|
12204
|
+
"title": "Days"
|
|
11811
12205
|
}
|
|
11812
12206
|
},
|
|
11813
12207
|
{
|
|
11814
|
-
"in": "
|
|
11815
|
-
"name": "
|
|
12208
|
+
"in": "query",
|
|
12209
|
+
"name": "start",
|
|
11816
12210
|
"required": false,
|
|
11817
12211
|
"schema": {
|
|
11818
12212
|
"anyOf": [
|
|
11819
12213
|
{
|
|
12214
|
+
"format": "date-time",
|
|
11820
12215
|
"type": "string"
|
|
11821
12216
|
},
|
|
11822
12217
|
{
|
|
11823
12218
|
"type": "null"
|
|
11824
12219
|
}
|
|
11825
12220
|
],
|
|
11826
|
-
"title": "
|
|
12221
|
+
"title": "Start"
|
|
11827
12222
|
}
|
|
11828
|
-
}
|
|
11829
|
-
],
|
|
11830
|
-
"responses": {
|
|
11831
|
-
"200": {
|
|
11832
|
-
"content": {
|
|
11833
|
-
"application/json": {
|
|
11834
|
-
"schema": {
|
|
11835
|
-
"$ref": "#/components/schemas/AlertResponse"
|
|
11836
|
-
}
|
|
11837
|
-
}
|
|
11838
|
-
},
|
|
11839
|
-
"description": "Successful Response"
|
|
11840
12223
|
},
|
|
11841
|
-
|
|
11842
|
-
"
|
|
11843
|
-
|
|
11844
|
-
|
|
11845
|
-
|
|
12224
|
+
{
|
|
12225
|
+
"in": "query",
|
|
12226
|
+
"name": "end",
|
|
12227
|
+
"required": false,
|
|
12228
|
+
"schema": {
|
|
12229
|
+
"anyOf": [
|
|
12230
|
+
{
|
|
12231
|
+
"format": "date-time",
|
|
12232
|
+
"type": "string"
|
|
12233
|
+
},
|
|
12234
|
+
{
|
|
12235
|
+
"type": "null"
|
|
11846
12236
|
}
|
|
11847
|
-
|
|
11848
|
-
|
|
11849
|
-
|
|
12237
|
+
],
|
|
12238
|
+
"title": "End"
|
|
12239
|
+
}
|
|
11850
12240
|
},
|
|
11851
|
-
|
|
11852
|
-
"
|
|
11853
|
-
|
|
11854
|
-
|
|
11855
|
-
|
|
12241
|
+
{
|
|
12242
|
+
"in": "query",
|
|
12243
|
+
"name": "account_type",
|
|
12244
|
+
"required": false,
|
|
12245
|
+
"schema": {
|
|
12246
|
+
"anyOf": [
|
|
12247
|
+
{
|
|
12248
|
+
"items": {
|
|
12249
|
+
"type": "string"
|
|
12250
|
+
},
|
|
12251
|
+
"type": "array"
|
|
12252
|
+
},
|
|
12253
|
+
{
|
|
12254
|
+
"type": "null"
|
|
11856
12255
|
}
|
|
11857
|
-
|
|
11858
|
-
|
|
11859
|
-
|
|
12256
|
+
],
|
|
12257
|
+
"title": "Account Type"
|
|
12258
|
+
}
|
|
11860
12259
|
},
|
|
11861
|
-
|
|
11862
|
-
"
|
|
11863
|
-
|
|
11864
|
-
|
|
11865
|
-
|
|
12260
|
+
{
|
|
12261
|
+
"in": "query",
|
|
12262
|
+
"name": "repository_id",
|
|
12263
|
+
"required": false,
|
|
12264
|
+
"schema": {
|
|
12265
|
+
"anyOf": [
|
|
12266
|
+
{
|
|
12267
|
+
"items": {
|
|
12268
|
+
"type": "integer"
|
|
12269
|
+
},
|
|
12270
|
+
"type": "array"
|
|
12271
|
+
},
|
|
12272
|
+
{
|
|
12273
|
+
"type": "null"
|
|
11866
12274
|
}
|
|
11867
|
-
|
|
11868
|
-
|
|
11869
|
-
|
|
12275
|
+
],
|
|
12276
|
+
"title": "Repository Id"
|
|
12277
|
+
}
|
|
11870
12278
|
},
|
|
11871
|
-
"422": {
|
|
11872
|
-
"content": {
|
|
11873
|
-
"application/json": {
|
|
11874
|
-
"schema": {
|
|
11875
|
-
"$ref": "#/components/schemas/HTTPValidationError"
|
|
11876
|
-
}
|
|
11877
|
-
}
|
|
11878
|
-
},
|
|
11879
|
-
"description": "Validation Error"
|
|
11880
|
-
}
|
|
11881
|
-
},
|
|
11882
|
-
"security": [
|
|
11883
12279
|
{
|
|
11884
|
-
"
|
|
11885
|
-
|
|
11886
|
-
|
|
11887
|
-
|
|
11888
|
-
|
|
11889
|
-
|
|
11890
|
-
|
|
11891
|
-
|
|
11892
|
-
|
|
11893
|
-
|
|
11894
|
-
|
|
11895
|
-
|
|
11896
|
-
|
|
11897
|
-
|
|
11898
|
-
|
|
12280
|
+
"in": "query",
|
|
12281
|
+
"name": "author_id",
|
|
12282
|
+
"required": false,
|
|
12283
|
+
"schema": {
|
|
12284
|
+
"anyOf": [
|
|
12285
|
+
{
|
|
12286
|
+
"items": {
|
|
12287
|
+
"type": "integer"
|
|
12288
|
+
},
|
|
12289
|
+
"type": "array"
|
|
12290
|
+
},
|
|
12291
|
+
{
|
|
12292
|
+
"type": "null"
|
|
12293
|
+
}
|
|
12294
|
+
],
|
|
12295
|
+
"title": "Author Id"
|
|
12296
|
+
}
|
|
12297
|
+
},
|
|
11899
12298
|
{
|
|
11900
|
-
"in": "
|
|
11901
|
-
"name": "
|
|
11902
|
-
"required":
|
|
12299
|
+
"in": "query",
|
|
12300
|
+
"name": "status",
|
|
12301
|
+
"required": false,
|
|
11903
12302
|
"schema": {
|
|
11904
|
-
"
|
|
11905
|
-
|
|
12303
|
+
"anyOf": [
|
|
12304
|
+
{
|
|
12305
|
+
"items": {
|
|
12306
|
+
"type": "string"
|
|
12307
|
+
},
|
|
12308
|
+
"type": "array"
|
|
12309
|
+
},
|
|
12310
|
+
{
|
|
12311
|
+
"type": "null"
|
|
12312
|
+
}
|
|
12313
|
+
],
|
|
12314
|
+
"title": "Status"
|
|
11906
12315
|
}
|
|
11907
12316
|
},
|
|
11908
12317
|
{
|
|
@@ -11927,23 +12336,13 @@
|
|
|
11927
12336
|
"content": {
|
|
11928
12337
|
"application/json": {
|
|
11929
12338
|
"schema": {
|
|
11930
|
-
"$ref": "#/components/schemas/
|
|
12339
|
+
"$ref": "#/components/schemas/GetAnalyticsPullRequestsResponse"
|
|
11931
12340
|
}
|
|
11932
12341
|
}
|
|
11933
12342
|
},
|
|
11934
12343
|
"description": "Successful Response"
|
|
11935
12344
|
},
|
|
11936
|
-
"
|
|
11937
|
-
"content": {
|
|
11938
|
-
"application/json": {
|
|
11939
|
-
"schema": {
|
|
11940
|
-
"$ref": "#/components/schemas/ErrorResponse"
|
|
11941
|
-
}
|
|
11942
|
-
}
|
|
11943
|
-
},
|
|
11944
|
-
"description": "The bearer token is missing, invalid, or revoked."
|
|
11945
|
-
},
|
|
11946
|
-
"403": {
|
|
12345
|
+
"400": {
|
|
11947
12346
|
"content": {
|
|
11948
12347
|
"application/json": {
|
|
11949
12348
|
"schema": {
|
|
@@ -11951,9 +12350,9 @@
|
|
|
11951
12350
|
}
|
|
11952
12351
|
}
|
|
11953
12352
|
},
|
|
11954
|
-
"description": "The
|
|
12353
|
+
"description": "The time window is invalid: days combined with start, a non-positive days, or end not after start."
|
|
11955
12354
|
},
|
|
11956
|
-
"
|
|
12355
|
+
"401": {
|
|
11957
12356
|
"content": {
|
|
11958
12357
|
"application/json": {
|
|
11959
12358
|
"schema": {
|
|
@@ -11961,9 +12360,9 @@
|
|
|
11961
12360
|
}
|
|
11962
12361
|
}
|
|
11963
12362
|
},
|
|
11964
|
-
"description": "
|
|
12363
|
+
"description": "The bearer token is missing, invalid, or revoked."
|
|
11965
12364
|
},
|
|
11966
|
-
"
|
|
12365
|
+
"403": {
|
|
11967
12366
|
"content": {
|
|
11968
12367
|
"application/json": {
|
|
11969
12368
|
"schema": {
|
|
@@ -11971,7 +12370,7 @@
|
|
|
11971
12370
|
}
|
|
11972
12371
|
}
|
|
11973
12372
|
},
|
|
11974
|
-
"description": "The
|
|
12373
|
+
"description": "The credential may not perform this action, or the account is blocked."
|
|
11975
12374
|
},
|
|
11976
12375
|
"422": {
|
|
11977
12376
|
"content": {
|
|
@@ -11989,17 +12388,18 @@
|
|
|
11989
12388
|
"HTTPBearer": []
|
|
11990
12389
|
}
|
|
11991
12390
|
],
|
|
11992
|
-
"summary": "
|
|
12391
|
+
"summary": "Get Analytics Pull Requests",
|
|
11993
12392
|
"tags": [
|
|
11994
12393
|
"v1"
|
|
11995
12394
|
],
|
|
11996
|
-
"x-ellipsis-sdk-method": "
|
|
12395
|
+
"x-ellipsis-sdk-method": "analytics.pull_requests",
|
|
12396
|
+
"x-ellipsis-undocumented": true
|
|
11997
12397
|
}
|
|
11998
12398
|
},
|
|
11999
|
-
"/v1/analytics/
|
|
12399
|
+
"/v1/analytics/reviews": {
|
|
12000
12400
|
"get": {
|
|
12001
|
-
"description": "Return
|
|
12002
|
-
"operationId": "
|
|
12401
|
+
"description": "Return code-review analytics.\n\naccount_type scopes reviewers (bot|user|all) \u2014 e.g. \"what apps\nreview the most PRs?\" is the reviewer facets here with\naccount_type=bot. Windowing: pass explicit start/end, or days\n(default: the last 30 days).",
|
|
12402
|
+
"operationId": "get_analytics_reviews",
|
|
12003
12403
|
"parameters": [
|
|
12004
12404
|
{
|
|
12005
12405
|
"in": "query",
|
|
@@ -12052,7 +12452,6 @@
|
|
|
12052
12452
|
}
|
|
12053
12453
|
},
|
|
12054
12454
|
{
|
|
12055
|
-
"description": "Filter to repositories by \"owner/name\".",
|
|
12056
12455
|
"in": "query",
|
|
12057
12456
|
"name": "repo",
|
|
12058
12457
|
"required": false,
|
|
@@ -12068,12 +12467,11 @@
|
|
|
12068
12467
|
"type": "null"
|
|
12069
12468
|
}
|
|
12070
12469
|
],
|
|
12071
|
-
"description": "Filter to repositories by \"owner/name\".",
|
|
12072
12470
|
"title": "Repo"
|
|
12073
12471
|
}
|
|
12074
12472
|
},
|
|
12075
12473
|
{
|
|
12076
|
-
"description": "Filter by
|
|
12474
|
+
"description": "Filter by reviewer login(s).",
|
|
12077
12475
|
"in": "query",
|
|
12078
12476
|
"name": "author",
|
|
12079
12477
|
"required": false,
|
|
@@ -12089,7 +12487,7 @@
|
|
|
12089
12487
|
"type": "null"
|
|
12090
12488
|
}
|
|
12091
12489
|
],
|
|
12092
|
-
"description": "Filter by
|
|
12490
|
+
"description": "Filter by reviewer login(s).",
|
|
12093
12491
|
"title": "Author"
|
|
12094
12492
|
}
|
|
12095
12493
|
},
|
|
@@ -12104,9 +12502,8 @@
|
|
|
12104
12502
|
}
|
|
12105
12503
|
},
|
|
12106
12504
|
{
|
|
12107
|
-
"description": "Filter by parent-PR status (open|draft|merged|closed).",
|
|
12108
12505
|
"in": "query",
|
|
12109
|
-
"name": "
|
|
12506
|
+
"name": "review_state",
|
|
12110
12507
|
"required": false,
|
|
12111
12508
|
"schema": {
|
|
12112
12509
|
"anyOf": [
|
|
@@ -12120,8 +12517,7 @@
|
|
|
12120
12517
|
"type": "null"
|
|
12121
12518
|
}
|
|
12122
12519
|
],
|
|
12123
|
-
"
|
|
12124
|
-
"title": "Status"
|
|
12520
|
+
"title": "Review State"
|
|
12125
12521
|
}
|
|
12126
12522
|
},
|
|
12127
12523
|
{
|
|
@@ -12146,7 +12542,7 @@
|
|
|
12146
12542
|
"content": {
|
|
12147
12543
|
"application/json": {
|
|
12148
12544
|
"schema": {
|
|
12149
|
-
"$ref": "#/components/schemas/
|
|
12545
|
+
"$ref": "#/components/schemas/GetAnalyticsReviewsResponse"
|
|
12150
12546
|
}
|
|
12151
12547
|
}
|
|
12152
12548
|
},
|
|
@@ -12198,144 +12594,137 @@
|
|
|
12198
12594
|
"HTTPBearer": []
|
|
12199
12595
|
}
|
|
12200
12596
|
],
|
|
12201
|
-
"summary": "Get Analytics
|
|
12597
|
+
"summary": "Get Analytics Reviews",
|
|
12202
12598
|
"tags": [
|
|
12203
12599
|
"v1"
|
|
12204
12600
|
],
|
|
12205
|
-
"x-ellipsis-sdk-method": "analytics.
|
|
12601
|
+
"x-ellipsis-sdk-method": "analytics.reviews",
|
|
12602
|
+
"x-ellipsis-undocumented": true
|
|
12206
12603
|
}
|
|
12207
12604
|
},
|
|
12208
|
-
"/v1/
|
|
12209
|
-
"
|
|
12210
|
-
"description": "
|
|
12211
|
-
"operationId": "
|
|
12212
|
-
"
|
|
12213
|
-
{
|
|
12214
|
-
"
|
|
12215
|
-
|
|
12216
|
-
|
|
12217
|
-
|
|
12218
|
-
"anyOf": [
|
|
12219
|
-
{
|
|
12220
|
-
"type": "integer"
|
|
12221
|
-
},
|
|
12222
|
-
{
|
|
12223
|
-
"type": "null"
|
|
12224
|
-
}
|
|
12225
|
-
],
|
|
12226
|
-
"title": "Days"
|
|
12605
|
+
"/v1/auth/cli/poll": {
|
|
12606
|
+
"post": {
|
|
12607
|
+
"description": "Poll a device-code auth flow for its token.\n\nUnauthenticated; the device code identifies the flow.",
|
|
12608
|
+
"operationId": "cli_auth_poll",
|
|
12609
|
+
"requestBody": {
|
|
12610
|
+
"content": {
|
|
12611
|
+
"application/json": {
|
|
12612
|
+
"schema": {
|
|
12613
|
+
"$ref": "#/components/schemas/CliAuthPollRequest"
|
|
12614
|
+
}
|
|
12227
12615
|
}
|
|
12228
12616
|
},
|
|
12229
|
-
|
|
12230
|
-
|
|
12231
|
-
|
|
12232
|
-
|
|
12233
|
-
"
|
|
12234
|
-
"
|
|
12235
|
-
{
|
|
12236
|
-
"
|
|
12237
|
-
"type": "string"
|
|
12238
|
-
},
|
|
12239
|
-
{
|
|
12240
|
-
"type": "null"
|
|
12617
|
+
"required": true
|
|
12618
|
+
},
|
|
12619
|
+
"responses": {
|
|
12620
|
+
"200": {
|
|
12621
|
+
"content": {
|
|
12622
|
+
"application/json": {
|
|
12623
|
+
"schema": {
|
|
12624
|
+
"$ref": "#/components/schemas/PollCliAuthResponse"
|
|
12241
12625
|
}
|
|
12242
|
-
|
|
12243
|
-
|
|
12244
|
-
|
|
12626
|
+
}
|
|
12627
|
+
},
|
|
12628
|
+
"description": "Successful Response"
|
|
12245
12629
|
},
|
|
12246
|
-
{
|
|
12247
|
-
"
|
|
12248
|
-
|
|
12249
|
-
|
|
12250
|
-
|
|
12251
|
-
"anyOf": [
|
|
12252
|
-
{
|
|
12253
|
-
"format": "date-time",
|
|
12254
|
-
"type": "string"
|
|
12255
|
-
},
|
|
12256
|
-
{
|
|
12257
|
-
"type": "null"
|
|
12630
|
+
"401": {
|
|
12631
|
+
"content": {
|
|
12632
|
+
"application/json": {
|
|
12633
|
+
"schema": {
|
|
12634
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
12258
12635
|
}
|
|
12259
|
-
|
|
12260
|
-
|
|
12261
|
-
|
|
12636
|
+
}
|
|
12637
|
+
},
|
|
12638
|
+
"description": "The bearer token is missing, invalid, or revoked."
|
|
12262
12639
|
},
|
|
12263
|
-
{
|
|
12264
|
-
"
|
|
12265
|
-
|
|
12266
|
-
|
|
12267
|
-
|
|
12268
|
-
"anyOf": [
|
|
12269
|
-
{
|
|
12270
|
-
"items": {
|
|
12271
|
-
"type": "string"
|
|
12272
|
-
},
|
|
12273
|
-
"type": "array"
|
|
12274
|
-
},
|
|
12275
|
-
{
|
|
12276
|
-
"type": "null"
|
|
12640
|
+
"403": {
|
|
12641
|
+
"content": {
|
|
12642
|
+
"application/json": {
|
|
12643
|
+
"schema": {
|
|
12644
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
12277
12645
|
}
|
|
12278
|
-
|
|
12279
|
-
|
|
12280
|
-
|
|
12646
|
+
}
|
|
12647
|
+
},
|
|
12648
|
+
"description": "The credential may not perform this action, or the account is blocked."
|
|
12281
12649
|
},
|
|
12282
|
-
{
|
|
12283
|
-
"
|
|
12284
|
-
|
|
12285
|
-
|
|
12286
|
-
|
|
12287
|
-
"anyOf": [
|
|
12288
|
-
{
|
|
12289
|
-
"items": {
|
|
12290
|
-
"type": "integer"
|
|
12291
|
-
},
|
|
12292
|
-
"type": "array"
|
|
12293
|
-
},
|
|
12294
|
-
{
|
|
12295
|
-
"type": "null"
|
|
12650
|
+
"404": {
|
|
12651
|
+
"content": {
|
|
12652
|
+
"application/json": {
|
|
12653
|
+
"schema": {
|
|
12654
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
12296
12655
|
}
|
|
12297
|
-
|
|
12298
|
-
|
|
12299
|
-
|
|
12656
|
+
}
|
|
12657
|
+
},
|
|
12658
|
+
"description": "Unknown device code."
|
|
12300
12659
|
},
|
|
12301
|
-
{
|
|
12302
|
-
"
|
|
12303
|
-
|
|
12304
|
-
|
|
12305
|
-
|
|
12306
|
-
"anyOf": [
|
|
12307
|
-
{
|
|
12308
|
-
"items": {
|
|
12309
|
-
"type": "integer"
|
|
12310
|
-
},
|
|
12311
|
-
"type": "array"
|
|
12312
|
-
},
|
|
12313
|
-
{
|
|
12314
|
-
"type": "null"
|
|
12660
|
+
"422": {
|
|
12661
|
+
"content": {
|
|
12662
|
+
"application/json": {
|
|
12663
|
+
"schema": {
|
|
12664
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
12315
12665
|
}
|
|
12316
|
-
|
|
12317
|
-
|
|
12318
|
-
|
|
12666
|
+
}
|
|
12667
|
+
},
|
|
12668
|
+
"description": "Validation Error"
|
|
12669
|
+
}
|
|
12670
|
+
},
|
|
12671
|
+
"summary": "Cli Auth Poll",
|
|
12672
|
+
"tags": [
|
|
12673
|
+
"v1"
|
|
12674
|
+
],
|
|
12675
|
+
"x-ellipsis-sdk-method": "auth.cli.poll",
|
|
12676
|
+
"x-ellipsis-undocumented": true
|
|
12677
|
+
}
|
|
12678
|
+
},
|
|
12679
|
+
"/v1/auth/cli/start": {
|
|
12680
|
+
"post": {
|
|
12681
|
+
"description": "Start a device-code auth flow for the CLI.\n\nUnauthenticated: the CLI has no credential yet \u2014 that's what\nit's obtaining. The human authorizes out-of-band in the\ndashboard.",
|
|
12682
|
+
"operationId": "cli_auth_start",
|
|
12683
|
+
"responses": {
|
|
12684
|
+
"201": {
|
|
12685
|
+
"content": {
|
|
12686
|
+
"application/json": {
|
|
12687
|
+
"schema": {
|
|
12688
|
+
"$ref": "#/components/schemas/StartCliAuthResponse"
|
|
12689
|
+
}
|
|
12690
|
+
}
|
|
12691
|
+
},
|
|
12692
|
+
"description": "Successful Response"
|
|
12319
12693
|
},
|
|
12320
|
-
{
|
|
12321
|
-
"
|
|
12322
|
-
|
|
12323
|
-
|
|
12324
|
-
|
|
12325
|
-
"anyOf": [
|
|
12326
|
-
{
|
|
12327
|
-
"items": {
|
|
12328
|
-
"type": "string"
|
|
12329
|
-
},
|
|
12330
|
-
"type": "array"
|
|
12331
|
-
},
|
|
12332
|
-
{
|
|
12333
|
-
"type": "null"
|
|
12694
|
+
"401": {
|
|
12695
|
+
"content": {
|
|
12696
|
+
"application/json": {
|
|
12697
|
+
"schema": {
|
|
12698
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
12334
12699
|
}
|
|
12335
|
-
|
|
12336
|
-
|
|
12337
|
-
|
|
12700
|
+
}
|
|
12701
|
+
},
|
|
12702
|
+
"description": "The bearer token is missing, invalid, or revoked."
|
|
12338
12703
|
},
|
|
12704
|
+
"403": {
|
|
12705
|
+
"content": {
|
|
12706
|
+
"application/json": {
|
|
12707
|
+
"schema": {
|
|
12708
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
12709
|
+
}
|
|
12710
|
+
}
|
|
12711
|
+
},
|
|
12712
|
+
"description": "The credential may not perform this action, or the account is blocked."
|
|
12713
|
+
}
|
|
12714
|
+
},
|
|
12715
|
+
"summary": "Cli Auth Start",
|
|
12716
|
+
"tags": [
|
|
12717
|
+
"v1"
|
|
12718
|
+
],
|
|
12719
|
+
"x-ellipsis-sdk-method": "auth.cli.start",
|
|
12720
|
+
"x-ellipsis-undocumented": true
|
|
12721
|
+
}
|
|
12722
|
+
},
|
|
12723
|
+
"/v1/budget": {
|
|
12724
|
+
"get": {
|
|
12725
|
+
"description": "Return the caller's current budget summary.",
|
|
12726
|
+
"operationId": "get_budget",
|
|
12727
|
+
"parameters": [
|
|
12339
12728
|
{
|
|
12340
12729
|
"in": "header",
|
|
12341
12730
|
"name": "user-agent",
|
|
@@ -12358,22 +12747,12 @@
|
|
|
12358
12747
|
"content": {
|
|
12359
12748
|
"application/json": {
|
|
12360
12749
|
"schema": {
|
|
12361
|
-
"$ref": "#/components/schemas/
|
|
12750
|
+
"$ref": "#/components/schemas/BudgetSummary"
|
|
12362
12751
|
}
|
|
12363
12752
|
}
|
|
12364
12753
|
},
|
|
12365
12754
|
"description": "Successful Response"
|
|
12366
12755
|
},
|
|
12367
|
-
"400": {
|
|
12368
|
-
"content": {
|
|
12369
|
-
"application/json": {
|
|
12370
|
-
"schema": {
|
|
12371
|
-
"$ref": "#/components/schemas/ErrorResponse"
|
|
12372
|
-
}
|
|
12373
|
-
}
|
|
12374
|
-
},
|
|
12375
|
-
"description": "The time window is invalid: days combined with start, a non-positive days, or end not after start."
|
|
12376
|
-
},
|
|
12377
12756
|
"401": {
|
|
12378
12757
|
"content": {
|
|
12379
12758
|
"application/json": {
|
|
@@ -12410,137 +12789,92 @@
|
|
|
12410
12789
|
"HTTPBearer": []
|
|
12411
12790
|
}
|
|
12412
12791
|
],
|
|
12413
|
-
"summary": "Get
|
|
12792
|
+
"summary": "Get Budget",
|
|
12414
12793
|
"tags": [
|
|
12415
12794
|
"v1"
|
|
12416
12795
|
],
|
|
12417
|
-
"x-ellipsis-sdk-method": "
|
|
12796
|
+
"x-ellipsis-sdk-method": "budget"
|
|
12418
12797
|
}
|
|
12419
12798
|
},
|
|
12420
|
-
"/v1/
|
|
12799
|
+
"/v1/environments": {
|
|
12421
12800
|
"get": {
|
|
12422
|
-
"description": "
|
|
12423
|
-
"operationId": "
|
|
12801
|
+
"description": "List saved environments.",
|
|
12802
|
+
"operationId": "list_environments",
|
|
12424
12803
|
"parameters": [
|
|
12425
12804
|
{
|
|
12426
|
-
"in": "
|
|
12427
|
-
"name": "
|
|
12428
|
-
"required": false,
|
|
12429
|
-
"schema": {
|
|
12430
|
-
"anyOf": [
|
|
12431
|
-
{
|
|
12432
|
-
"type": "integer"
|
|
12433
|
-
},
|
|
12434
|
-
{
|
|
12435
|
-
"type": "null"
|
|
12436
|
-
}
|
|
12437
|
-
],
|
|
12438
|
-
"title": "Days"
|
|
12439
|
-
}
|
|
12440
|
-
},
|
|
12441
|
-
{
|
|
12442
|
-
"in": "query",
|
|
12443
|
-
"name": "start",
|
|
12805
|
+
"in": "header",
|
|
12806
|
+
"name": "user-agent",
|
|
12444
12807
|
"required": false,
|
|
12445
12808
|
"schema": {
|
|
12446
12809
|
"anyOf": [
|
|
12447
12810
|
{
|
|
12448
|
-
"format": "date-time",
|
|
12449
12811
|
"type": "string"
|
|
12450
12812
|
},
|
|
12451
12813
|
{
|
|
12452
12814
|
"type": "null"
|
|
12453
12815
|
}
|
|
12454
12816
|
],
|
|
12455
|
-
"title": "
|
|
12817
|
+
"title": "User-Agent"
|
|
12456
12818
|
}
|
|
12457
|
-
}
|
|
12458
|
-
|
|
12459
|
-
|
|
12460
|
-
|
|
12461
|
-
"
|
|
12462
|
-
|
|
12463
|
-
|
|
12464
|
-
|
|
12465
|
-
"format": "date-time",
|
|
12466
|
-
"type": "string"
|
|
12467
|
-
},
|
|
12468
|
-
{
|
|
12469
|
-
"type": "null"
|
|
12819
|
+
}
|
|
12820
|
+
],
|
|
12821
|
+
"responses": {
|
|
12822
|
+
"200": {
|
|
12823
|
+
"content": {
|
|
12824
|
+
"application/json": {
|
|
12825
|
+
"schema": {
|
|
12826
|
+
"$ref": "#/components/schemas/EnvironmentsListResponse"
|
|
12470
12827
|
}
|
|
12471
|
-
|
|
12472
|
-
|
|
12473
|
-
|
|
12828
|
+
}
|
|
12829
|
+
},
|
|
12830
|
+
"description": "Successful Response"
|
|
12474
12831
|
},
|
|
12475
|
-
{
|
|
12476
|
-
"
|
|
12477
|
-
|
|
12478
|
-
|
|
12479
|
-
|
|
12480
|
-
"anyOf": [
|
|
12481
|
-
{
|
|
12482
|
-
"items": {
|
|
12483
|
-
"type": "string"
|
|
12484
|
-
},
|
|
12485
|
-
"type": "array"
|
|
12486
|
-
},
|
|
12487
|
-
{
|
|
12488
|
-
"type": "null"
|
|
12832
|
+
"401": {
|
|
12833
|
+
"content": {
|
|
12834
|
+
"application/json": {
|
|
12835
|
+
"schema": {
|
|
12836
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
12489
12837
|
}
|
|
12490
|
-
|
|
12491
|
-
|
|
12492
|
-
|
|
12838
|
+
}
|
|
12839
|
+
},
|
|
12840
|
+
"description": "The bearer token is missing, invalid, or revoked."
|
|
12493
12841
|
},
|
|
12494
|
-
{
|
|
12495
|
-
"
|
|
12496
|
-
|
|
12497
|
-
|
|
12498
|
-
|
|
12499
|
-
"schema": {
|
|
12500
|
-
"anyOf": [
|
|
12501
|
-
{
|
|
12502
|
-
"items": {
|
|
12503
|
-
"type": "string"
|
|
12504
|
-
},
|
|
12505
|
-
"type": "array"
|
|
12506
|
-
},
|
|
12507
|
-
{
|
|
12508
|
-
"type": "null"
|
|
12842
|
+
"403": {
|
|
12843
|
+
"content": {
|
|
12844
|
+
"application/json": {
|
|
12845
|
+
"schema": {
|
|
12846
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
12509
12847
|
}
|
|
12510
|
-
|
|
12511
|
-
|
|
12512
|
-
|
|
12513
|
-
}
|
|
12514
|
-
},
|
|
12515
|
-
{
|
|
12516
|
-
"in": "query",
|
|
12517
|
-
"name": "account_type",
|
|
12518
|
-
"required": false,
|
|
12519
|
-
"schema": {
|
|
12520
|
-
"default": "all",
|
|
12521
|
-
"title": "Account Type",
|
|
12522
|
-
"type": "string"
|
|
12523
|
-
}
|
|
12848
|
+
}
|
|
12849
|
+
},
|
|
12850
|
+
"description": "The credential may not perform this action, or the account is blocked."
|
|
12524
12851
|
},
|
|
12525
|
-
{
|
|
12526
|
-
"
|
|
12527
|
-
|
|
12528
|
-
|
|
12529
|
-
|
|
12530
|
-
"anyOf": [
|
|
12531
|
-
{
|
|
12532
|
-
"items": {
|
|
12533
|
-
"type": "string"
|
|
12534
|
-
},
|
|
12535
|
-
"type": "array"
|
|
12536
|
-
},
|
|
12537
|
-
{
|
|
12538
|
-
"type": "null"
|
|
12852
|
+
"422": {
|
|
12853
|
+
"content": {
|
|
12854
|
+
"application/json": {
|
|
12855
|
+
"schema": {
|
|
12856
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
12539
12857
|
}
|
|
12540
|
-
|
|
12541
|
-
|
|
12542
|
-
|
|
12543
|
-
}
|
|
12858
|
+
}
|
|
12859
|
+
},
|
|
12860
|
+
"description": "Validation Error"
|
|
12861
|
+
}
|
|
12862
|
+
},
|
|
12863
|
+
"security": [
|
|
12864
|
+
{
|
|
12865
|
+
"HTTPBearer": []
|
|
12866
|
+
}
|
|
12867
|
+
],
|
|
12868
|
+
"summary": "List Environments",
|
|
12869
|
+
"tags": [
|
|
12870
|
+
"v1"
|
|
12871
|
+
],
|
|
12872
|
+
"x-ellipsis-sdk-method": "environments.list"
|
|
12873
|
+
},
|
|
12874
|
+
"post": {
|
|
12875
|
+
"description": "Create an environment, managed through the API: no file, live\nimmediately. To define it in a repository instead, commit a\n`kind: environment` YAML under an agents directory.\n\n409 when another live environment already holds the name.",
|
|
12876
|
+
"operationId": "create_environment",
|
|
12877
|
+
"parameters": [
|
|
12544
12878
|
{
|
|
12545
12879
|
"in": "header",
|
|
12546
12880
|
"name": "user-agent",
|
|
@@ -12558,12 +12892,22 @@
|
|
|
12558
12892
|
}
|
|
12559
12893
|
}
|
|
12560
12894
|
],
|
|
12895
|
+
"requestBody": {
|
|
12896
|
+
"content": {
|
|
12897
|
+
"application/json": {
|
|
12898
|
+
"schema": {
|
|
12899
|
+
"$ref": "#/components/schemas/CreateEnvironmentRequest"
|
|
12900
|
+
}
|
|
12901
|
+
}
|
|
12902
|
+
},
|
|
12903
|
+
"required": true
|
|
12904
|
+
},
|
|
12561
12905
|
"responses": {
|
|
12562
|
-
"
|
|
12906
|
+
"201": {
|
|
12563
12907
|
"content": {
|
|
12564
12908
|
"application/json": {
|
|
12565
12909
|
"schema": {
|
|
12566
|
-
"$ref": "#/components/schemas/
|
|
12910
|
+
"$ref": "#/components/schemas/EnvironmentResponse"
|
|
12567
12911
|
}
|
|
12568
12912
|
}
|
|
12569
12913
|
},
|
|
@@ -12577,7 +12921,7 @@
|
|
|
12577
12921
|
}
|
|
12578
12922
|
}
|
|
12579
12923
|
},
|
|
12580
|
-
"description": "The
|
|
12924
|
+
"description": "The environment is invalid."
|
|
12581
12925
|
},
|
|
12582
12926
|
"401": {
|
|
12583
12927
|
"content": {
|
|
@@ -12599,15 +12943,25 @@
|
|
|
12599
12943
|
},
|
|
12600
12944
|
"description": "The credential may not perform this action, or the account is blocked."
|
|
12601
12945
|
},
|
|
12946
|
+
"409": {
|
|
12947
|
+
"content": {
|
|
12948
|
+
"application/json": {
|
|
12949
|
+
"schema": {
|
|
12950
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
12951
|
+
}
|
|
12952
|
+
}
|
|
12953
|
+
},
|
|
12954
|
+
"description": "An environment with that name already exists."
|
|
12955
|
+
},
|
|
12602
12956
|
"422": {
|
|
12603
12957
|
"content": {
|
|
12604
12958
|
"application/json": {
|
|
12605
12959
|
"schema": {
|
|
12606
|
-
"$ref": "#/components/schemas/
|
|
12960
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
12607
12961
|
}
|
|
12608
12962
|
}
|
|
12609
12963
|
},
|
|
12610
|
-
"description": "
|
|
12964
|
+
"description": "The environment's name is missing or malformed."
|
|
12611
12965
|
}
|
|
12612
12966
|
},
|
|
12613
12967
|
"security": [
|
|
@@ -12615,36 +12969,46 @@
|
|
|
12615
12969
|
"HTTPBearer": []
|
|
12616
12970
|
}
|
|
12617
12971
|
],
|
|
12618
|
-
"summary": "
|
|
12972
|
+
"summary": "Create Environment",
|
|
12619
12973
|
"tags": [
|
|
12620
12974
|
"v1"
|
|
12621
12975
|
],
|
|
12622
|
-
"x-ellipsis-sdk-method": "
|
|
12976
|
+
"x-ellipsis-sdk-method": "environments.create"
|
|
12623
12977
|
}
|
|
12624
12978
|
},
|
|
12625
|
-
"/v1/
|
|
12626
|
-
"
|
|
12627
|
-
"description": "
|
|
12628
|
-
"operationId": "
|
|
12629
|
-
"
|
|
12630
|
-
|
|
12631
|
-
"
|
|
12632
|
-
|
|
12633
|
-
|
|
12634
|
-
|
|
12979
|
+
"/v1/environments/{environment_id}": {
|
|
12980
|
+
"delete": {
|
|
12981
|
+
"description": "Delete an environment, by id or by name.\n\nAlways succeeds, even while agents still reference it \u2014 their next\nsession start fails with a clear error naming the missing\nenvironment. Past sessions remain readable. Only for environments\nmanaged through this API \u2014 delete the file to remove one defined\nby a repository.",
|
|
12982
|
+
"operationId": "delete_environment",
|
|
12983
|
+
"parameters": [
|
|
12984
|
+
{
|
|
12985
|
+
"in": "path",
|
|
12986
|
+
"name": "environment_id",
|
|
12987
|
+
"required": true,
|
|
12988
|
+
"schema": {
|
|
12989
|
+
"title": "Environment Id",
|
|
12990
|
+
"type": "string"
|
|
12635
12991
|
}
|
|
12636
12992
|
},
|
|
12637
|
-
|
|
12638
|
-
|
|
12639
|
-
|
|
12640
|
-
|
|
12641
|
-
"
|
|
12642
|
-
"
|
|
12643
|
-
|
|
12644
|
-
"
|
|
12993
|
+
{
|
|
12994
|
+
"in": "header",
|
|
12995
|
+
"name": "user-agent",
|
|
12996
|
+
"required": false,
|
|
12997
|
+
"schema": {
|
|
12998
|
+
"anyOf": [
|
|
12999
|
+
{
|
|
13000
|
+
"type": "string"
|
|
13001
|
+
},
|
|
13002
|
+
{
|
|
13003
|
+
"type": "null"
|
|
12645
13004
|
}
|
|
12646
|
-
|
|
12647
|
-
|
|
13005
|
+
],
|
|
13006
|
+
"title": "User-Agent"
|
|
13007
|
+
}
|
|
13008
|
+
}
|
|
13009
|
+
],
|
|
13010
|
+
"responses": {
|
|
13011
|
+
"204": {
|
|
12648
13012
|
"description": "Successful Response"
|
|
12649
13013
|
},
|
|
12650
13014
|
"401": {
|
|
@@ -12675,7 +13039,17 @@
|
|
|
12675
13039
|
}
|
|
12676
13040
|
}
|
|
12677
13041
|
},
|
|
12678
|
-
"description": "
|
|
13042
|
+
"description": "No such environment in your account."
|
|
13043
|
+
},
|
|
13044
|
+
"409": {
|
|
13045
|
+
"content": {
|
|
13046
|
+
"application/json": {
|
|
13047
|
+
"schema": {
|
|
13048
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
13049
|
+
}
|
|
13050
|
+
}
|
|
13051
|
+
},
|
|
13052
|
+
"description": "The environment is defined by a file in a repository; delete that file instead."
|
|
12679
13053
|
},
|
|
12680
13054
|
"422": {
|
|
12681
13055
|
"content": {
|
|
@@ -12688,23 +13062,53 @@
|
|
|
12688
13062
|
"description": "Validation Error"
|
|
12689
13063
|
}
|
|
12690
13064
|
},
|
|
12691
|
-
"
|
|
13065
|
+
"security": [
|
|
13066
|
+
{
|
|
13067
|
+
"HTTPBearer": []
|
|
13068
|
+
}
|
|
13069
|
+
],
|
|
13070
|
+
"summary": "Delete Environment",
|
|
12692
13071
|
"tags": [
|
|
12693
13072
|
"v1"
|
|
12694
13073
|
],
|
|
12695
|
-
"x-ellipsis-sdk-method": "
|
|
12696
|
-
}
|
|
12697
|
-
|
|
12698
|
-
|
|
12699
|
-
|
|
12700
|
-
"
|
|
12701
|
-
|
|
13074
|
+
"x-ellipsis-sdk-method": "environments.delete"
|
|
13075
|
+
},
|
|
13076
|
+
"get": {
|
|
13077
|
+
"description": "Return one saved environment, by id or by name.",
|
|
13078
|
+
"operationId": "get_environment",
|
|
13079
|
+
"parameters": [
|
|
13080
|
+
{
|
|
13081
|
+
"in": "path",
|
|
13082
|
+
"name": "environment_id",
|
|
13083
|
+
"required": true,
|
|
13084
|
+
"schema": {
|
|
13085
|
+
"title": "Environment Id",
|
|
13086
|
+
"type": "string"
|
|
13087
|
+
}
|
|
13088
|
+
},
|
|
13089
|
+
{
|
|
13090
|
+
"in": "header",
|
|
13091
|
+
"name": "user-agent",
|
|
13092
|
+
"required": false,
|
|
13093
|
+
"schema": {
|
|
13094
|
+
"anyOf": [
|
|
13095
|
+
{
|
|
13096
|
+
"type": "string"
|
|
13097
|
+
},
|
|
13098
|
+
{
|
|
13099
|
+
"type": "null"
|
|
13100
|
+
}
|
|
13101
|
+
],
|
|
13102
|
+
"title": "User-Agent"
|
|
13103
|
+
}
|
|
13104
|
+
}
|
|
13105
|
+
],
|
|
12702
13106
|
"responses": {
|
|
12703
|
-
"
|
|
13107
|
+
"200": {
|
|
12704
13108
|
"content": {
|
|
12705
13109
|
"application/json": {
|
|
12706
13110
|
"schema": {
|
|
12707
|
-
"$ref": "#/components/schemas/
|
|
13111
|
+
"$ref": "#/components/schemas/EnvironmentResponse"
|
|
12708
13112
|
}
|
|
12709
13113
|
}
|
|
12710
13114
|
},
|
|
@@ -12729,20 +13133,52 @@
|
|
|
12729
13133
|
}
|
|
12730
13134
|
},
|
|
12731
13135
|
"description": "The credential may not perform this action, or the account is blocked."
|
|
13136
|
+
},
|
|
13137
|
+
"404": {
|
|
13138
|
+
"content": {
|
|
13139
|
+
"application/json": {
|
|
13140
|
+
"schema": {
|
|
13141
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
13142
|
+
}
|
|
13143
|
+
}
|
|
13144
|
+
},
|
|
13145
|
+
"description": "No such environment in your account."
|
|
13146
|
+
},
|
|
13147
|
+
"422": {
|
|
13148
|
+
"content": {
|
|
13149
|
+
"application/json": {
|
|
13150
|
+
"schema": {
|
|
13151
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
13152
|
+
}
|
|
13153
|
+
}
|
|
13154
|
+
},
|
|
13155
|
+
"description": "Validation Error"
|
|
12732
13156
|
}
|
|
12733
13157
|
},
|
|
12734
|
-
"
|
|
13158
|
+
"security": [
|
|
13159
|
+
{
|
|
13160
|
+
"HTTPBearer": []
|
|
13161
|
+
}
|
|
13162
|
+
],
|
|
13163
|
+
"summary": "Get Environment",
|
|
12735
13164
|
"tags": [
|
|
12736
13165
|
"v1"
|
|
12737
13166
|
],
|
|
12738
|
-
"x-ellipsis-sdk-method": "
|
|
12739
|
-
}
|
|
12740
|
-
|
|
12741
|
-
|
|
12742
|
-
|
|
12743
|
-
"description": "Return the caller's current budget summary.",
|
|
12744
|
-
"operationId": "get_budget",
|
|
13167
|
+
"x-ellipsis-sdk-method": "environments.get"
|
|
13168
|
+
},
|
|
13169
|
+
"put": {
|
|
13170
|
+
"description": "Replace an environment's definition, by id or by name.\n\nThe whole definition is replaced, live at once \u2014 future sessions\nresolve the new body; running sessions keep the one frozen at\ntheir start. Only for environments managed through this API: one\ndefined by a repository file is a 409.",
|
|
13171
|
+
"operationId": "update_environment",
|
|
12745
13172
|
"parameters": [
|
|
13173
|
+
{
|
|
13174
|
+
"in": "path",
|
|
13175
|
+
"name": "environment_id",
|
|
13176
|
+
"required": true,
|
|
13177
|
+
"schema": {
|
|
13178
|
+
"title": "Environment Id",
|
|
13179
|
+
"type": "string"
|
|
13180
|
+
}
|
|
13181
|
+
},
|
|
12746
13182
|
{
|
|
12747
13183
|
"in": "header",
|
|
12748
13184
|
"name": "user-agent",
|
|
@@ -12760,17 +13196,37 @@
|
|
|
12760
13196
|
}
|
|
12761
13197
|
}
|
|
12762
13198
|
],
|
|
13199
|
+
"requestBody": {
|
|
13200
|
+
"content": {
|
|
13201
|
+
"application/json": {
|
|
13202
|
+
"schema": {
|
|
13203
|
+
"$ref": "#/components/schemas/UpdateEnvironmentRequest"
|
|
13204
|
+
}
|
|
13205
|
+
}
|
|
13206
|
+
},
|
|
13207
|
+
"required": true
|
|
13208
|
+
},
|
|
12763
13209
|
"responses": {
|
|
12764
13210
|
"200": {
|
|
12765
13211
|
"content": {
|
|
12766
13212
|
"application/json": {
|
|
12767
13213
|
"schema": {
|
|
12768
|
-
"$ref": "#/components/schemas/
|
|
13214
|
+
"$ref": "#/components/schemas/EnvironmentResponse"
|
|
12769
13215
|
}
|
|
12770
13216
|
}
|
|
12771
13217
|
},
|
|
12772
13218
|
"description": "Successful Response"
|
|
12773
13219
|
},
|
|
13220
|
+
"400": {
|
|
13221
|
+
"content": {
|
|
13222
|
+
"application/json": {
|
|
13223
|
+
"schema": {
|
|
13224
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
13225
|
+
}
|
|
13226
|
+
}
|
|
13227
|
+
},
|
|
13228
|
+
"description": "The environment is invalid."
|
|
13229
|
+
},
|
|
12774
13230
|
"401": {
|
|
12775
13231
|
"content": {
|
|
12776
13232
|
"application/json": {
|
|
@@ -12791,15 +13247,35 @@
|
|
|
12791
13247
|
},
|
|
12792
13248
|
"description": "The credential may not perform this action, or the account is blocked."
|
|
12793
13249
|
},
|
|
13250
|
+
"404": {
|
|
13251
|
+
"content": {
|
|
13252
|
+
"application/json": {
|
|
13253
|
+
"schema": {
|
|
13254
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
13255
|
+
}
|
|
13256
|
+
}
|
|
13257
|
+
},
|
|
13258
|
+
"description": "No such environment in your account."
|
|
13259
|
+
},
|
|
13260
|
+
"409": {
|
|
13261
|
+
"content": {
|
|
13262
|
+
"application/json": {
|
|
13263
|
+
"schema": {
|
|
13264
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
13265
|
+
}
|
|
13266
|
+
}
|
|
13267
|
+
},
|
|
13268
|
+
"description": "The environment is defined by a file in a repository, or another live environment already holds the new name."
|
|
13269
|
+
},
|
|
12794
13270
|
"422": {
|
|
12795
13271
|
"content": {
|
|
12796
13272
|
"application/json": {
|
|
12797
13273
|
"schema": {
|
|
12798
|
-
"$ref": "#/components/schemas/
|
|
13274
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
12799
13275
|
}
|
|
12800
13276
|
}
|
|
12801
13277
|
},
|
|
12802
|
-
"description": "
|
|
13278
|
+
"description": "The environment's name is missing or malformed."
|
|
12803
13279
|
}
|
|
12804
13280
|
},
|
|
12805
13281
|
"security": [
|
|
@@ -12807,11 +13283,11 @@
|
|
|
12807
13283
|
"HTTPBearer": []
|
|
12808
13284
|
}
|
|
12809
13285
|
],
|
|
12810
|
-
"summary": "
|
|
13286
|
+
"summary": "Update Environment",
|
|
12811
13287
|
"tags": [
|
|
12812
13288
|
"v1"
|
|
12813
13289
|
],
|
|
12814
|
-
"x-ellipsis-sdk-method": "
|
|
13290
|
+
"x-ellipsis-sdk-method": "environments.update"
|
|
12815
13291
|
}
|
|
12816
13292
|
},
|
|
12817
13293
|
"/v1/files": {
|
|
@@ -13288,7 +13764,7 @@
|
|
|
13288
13764
|
"HTTPBearer": []
|
|
13289
13765
|
}
|
|
13290
13766
|
],
|
|
13291
|
-
"summary": "
|
|
13767
|
+
"summary": "List Integrations",
|
|
13292
13768
|
"tags": [
|
|
13293
13769
|
"v1"
|
|
13294
13770
|
],
|
|
@@ -13850,7 +14326,7 @@
|
|
|
13850
14326
|
"HTTPBearer": []
|
|
13851
14327
|
}
|
|
13852
14328
|
],
|
|
13853
|
-
"summary": "
|
|
14329
|
+
"summary": "Current Identity",
|
|
13854
14330
|
"tags": [
|
|
13855
14331
|
"v1"
|
|
13856
14332
|
],
|
|
@@ -13948,7 +14424,8 @@
|
|
|
13948
14424
|
"tags": [
|
|
13949
14425
|
"v1"
|
|
13950
14426
|
],
|
|
13951
|
-
"x-ellipsis-sdk-method": "memories.list"
|
|
14427
|
+
"x-ellipsis-sdk-method": "memories.list",
|
|
14428
|
+
"x-ellipsis-undocumented": true
|
|
13952
14429
|
},
|
|
13953
14430
|
"post": {
|
|
13954
14431
|
"description": "Save a memory for future agent sessions.\n\nMemories are durable lessons shared across the whole\norganization \u2014 conventions, past decisions, known gotchas that an\nagent cannot derive from the repository itself. One concise fact\nper memory; the description is what a reader sees in the index.\n\nCreating never overwrites: a path that already exists is a 409, so\ncorrecting an existing memory is an explicit edit.",
|
|
@@ -14042,7 +14519,8 @@
|
|
|
14042
14519
|
"tags": [
|
|
14043
14520
|
"v1"
|
|
14044
14521
|
],
|
|
14045
|
-
"x-ellipsis-sdk-method": "memories.create"
|
|
14522
|
+
"x-ellipsis-sdk-method": "memories.create",
|
|
14523
|
+
"x-ellipsis-undocumented": true
|
|
14046
14524
|
}
|
|
14047
14525
|
},
|
|
14048
14526
|
"/v1/memories/{memory_id}": {
|
|
@@ -14158,7 +14636,8 @@
|
|
|
14158
14636
|
"tags": [
|
|
14159
14637
|
"v1"
|
|
14160
14638
|
],
|
|
14161
|
-
"x-ellipsis-sdk-method": "memories.delete"
|
|
14639
|
+
"x-ellipsis-sdk-method": "memories.delete",
|
|
14640
|
+
"x-ellipsis-undocumented": true
|
|
14162
14641
|
},
|
|
14163
14642
|
"get": {
|
|
14164
14643
|
"description": "Read one memory's full content.\n\nThe id comes from the index returned by listing memories.",
|
|
@@ -14251,7 +14730,8 @@
|
|
|
14251
14730
|
"tags": [
|
|
14252
14731
|
"v1"
|
|
14253
14732
|
],
|
|
14254
|
-
"x-ellipsis-sdk-method": "memories.get"
|
|
14733
|
+
"x-ellipsis-sdk-method": "memories.get",
|
|
14734
|
+
"x-ellipsis-undocumented": true
|
|
14255
14735
|
},
|
|
14256
14736
|
"put": {
|
|
14257
14737
|
"description": "Correct an existing memory in place.\n\nPass description, content, or both. This never creates a memory (an\nunknown id is a 404) and never moves one \u2014 the path is immutable, so\nrelocating a memory is a delete plus a create.\n\nPass `if_sha256` (from a previous read) to make a concurrent write\na 409 instead of silently overwriting it.",
|
|
@@ -14364,7 +14844,8 @@
|
|
|
14364
14844
|
"tags": [
|
|
14365
14845
|
"v1"
|
|
14366
14846
|
],
|
|
14367
|
-
"x-ellipsis-sdk-method": "memories.edit"
|
|
14847
|
+
"x-ellipsis-sdk-method": "memories.edit",
|
|
14848
|
+
"x-ellipsis-undocumented": true
|
|
14368
14849
|
}
|
|
14369
14850
|
},
|
|
14370
14851
|
"/v1/models": {
|
|
@@ -15003,7 +15484,7 @@
|
|
|
15003
15484
|
"HTTPBearer": []
|
|
15004
15485
|
}
|
|
15005
15486
|
],
|
|
15006
|
-
"summary": "
|
|
15487
|
+
"summary": "Set Secrets",
|
|
15007
15488
|
"tags": [
|
|
15008
15489
|
"v1"
|
|
15009
15490
|
],
|
|
@@ -15327,7 +15808,7 @@
|
|
|
15327
15808
|
"x-ellipsis-sdk-method": "sessions.list"
|
|
15328
15809
|
},
|
|
15329
15810
|
"post": {
|
|
15330
|
-
"description": "Start a cloud agent session.\n\
|
|
15811
|
+
"description": "Start a cloud agent session.\n\nThe base is `from_config_id` (an id or an agent name) or, omitted,\nthe bare ad-hoc config; every AgentConfig key on the request\ndeep-merges on top, so the body is both the pointer and the\nper-session override. `prompt` is the first message; omit it and\nthe session starts idle, waiting for one. 400 when\nellipsis.interactive=false and there is no prompt or input. 422\nwhen the agent declares an input schema and the request's input\nis absent or invalid.",
|
|
15331
15812
|
"operationId": "start_agent_session",
|
|
15332
15813
|
"parameters": [
|
|
15333
15814
|
{
|
|
@@ -15376,7 +15857,7 @@
|
|
|
15376
15857
|
}
|
|
15377
15858
|
}
|
|
15378
15859
|
},
|
|
15379
|
-
"description": "The request
|
|
15860
|
+
"description": "The request is incompatible with itself (a one-shot run with no prompt or input) or its config keys produce an invalid config."
|
|
15380
15861
|
},
|
|
15381
15862
|
"401": {
|
|
15382
15863
|
"content": {
|
|
@@ -15406,17 +15887,7 @@
|
|
|
15406
15887
|
}
|
|
15407
15888
|
}
|
|
15408
15889
|
},
|
|
15409
|
-
"description": "The named agent or
|
|
15410
|
-
},
|
|
15411
|
-
"409": {
|
|
15412
|
-
"content": {
|
|
15413
|
-
"application/json": {
|
|
15414
|
-
"schema": {
|
|
15415
|
-
"$ref": "#/components/schemas/ErrorResponse"
|
|
15416
|
-
}
|
|
15417
|
-
}
|
|
15418
|
-
},
|
|
15419
|
-
"description": "The resolved default config is broken (deleted, disabled, unmerged, or on an inaccessible repository)."
|
|
15890
|
+
"description": "The named agent or environment does not exist in your account."
|
|
15420
15891
|
},
|
|
15421
15892
|
"422": {
|
|
15422
15893
|
"content": {
|
|
@@ -15701,7 +16172,7 @@
|
|
|
15701
16172
|
"HTTPBearer": []
|
|
15702
16173
|
}
|
|
15703
16174
|
],
|
|
15704
|
-
"summary": "Search Sessions",
|
|
16175
|
+
"summary": "Search Agent Sessions",
|
|
15705
16176
|
"tags": [
|
|
15706
16177
|
"v1"
|
|
15707
16178
|
],
|
|
@@ -15805,7 +16276,7 @@
|
|
|
15805
16276
|
},
|
|
15806
16277
|
"/v1/sessions/{session_id}/executions": {
|
|
15807
16278
|
"get": {
|
|
15808
|
-
"description": "Return the session's executions and launch context.\n\nMost notably system_prompt_append, the text Ellipsis appends to\nClaude Code's default system prompt (platform section + response\ninstructions + the config's own instructions).\n\nPer execution because each cold wake persists its own launch\nconfig (a config edit
|
|
16279
|
+
"description": "Return the session's executions and launch context.\n\nMost notably system_prompt_append, the text Ellipsis appends to\nClaude Code's default system prompt (platform section + response\ninstructions + the config's own instructions).\n\nPer execution because each cold wake persists its own launch\nconfig (a config edit between wakes changes it).",
|
|
15809
16280
|
"operationId": "get_agent_session_executions",
|
|
15810
16281
|
"parameters": [
|
|
15811
16282
|
{
|
|
@@ -16342,10 +16813,10 @@
|
|
|
16342
16813
|
"x-ellipsis-sdk-method": "sessions.records"
|
|
16343
16814
|
}
|
|
16344
16815
|
},
|
|
16345
|
-
"/v1/sessions/{session_id}/
|
|
16816
|
+
"/v1/sessions/{session_id}/stop": {
|
|
16346
16817
|
"post": {
|
|
16347
|
-
"description": "
|
|
16348
|
-
"operationId": "
|
|
16818
|
+
"description": "Stop an in-flight session and return it.\n\nstopped_by is recorded only when the caller's credential maps\nto a GitHub account.",
|
|
16819
|
+
"operationId": "stop_agent_session",
|
|
16349
16820
|
"parameters": [
|
|
16350
16821
|
{
|
|
16351
16822
|
"in": "path",
|
|
@@ -16373,18 +16844,8 @@
|
|
|
16373
16844
|
}
|
|
16374
16845
|
}
|
|
16375
16846
|
],
|
|
16376
|
-
"requestBody": {
|
|
16377
|
-
"content": {
|
|
16378
|
-
"application/json": {
|
|
16379
|
-
"schema": {
|
|
16380
|
-
"$ref": "#/components/schemas/ReplayAgentSessionRequest"
|
|
16381
|
-
}
|
|
16382
|
-
}
|
|
16383
|
-
},
|
|
16384
|
-
"required": true
|
|
16385
|
-
},
|
|
16386
16847
|
"responses": {
|
|
16387
|
-
"
|
|
16848
|
+
"200": {
|
|
16388
16849
|
"content": {
|
|
16389
16850
|
"application/json": {
|
|
16390
16851
|
"schema": {
|
|
@@ -16394,7 +16855,7 @@
|
|
|
16394
16855
|
},
|
|
16395
16856
|
"description": "Successful Response"
|
|
16396
16857
|
},
|
|
16397
|
-
"
|
|
16858
|
+
"401": {
|
|
16398
16859
|
"content": {
|
|
16399
16860
|
"application/json": {
|
|
16400
16861
|
"schema": {
|
|
@@ -16402,9 +16863,9 @@
|
|
|
16402
16863
|
}
|
|
16403
16864
|
}
|
|
16404
16865
|
},
|
|
16405
|
-
"description": "The
|
|
16866
|
+
"description": "The bearer token is missing, invalid, or revoked."
|
|
16406
16867
|
},
|
|
16407
|
-
"
|
|
16868
|
+
"403": {
|
|
16408
16869
|
"content": {
|
|
16409
16870
|
"application/json": {
|
|
16410
16871
|
"schema": {
|
|
@@ -16412,9 +16873,9 @@
|
|
|
16412
16873
|
}
|
|
16413
16874
|
}
|
|
16414
16875
|
},
|
|
16415
|
-
"description": "The
|
|
16876
|
+
"description": "The credential may not perform this action, or the account is blocked."
|
|
16416
16877
|
},
|
|
16417
|
-
"
|
|
16878
|
+
"404": {
|
|
16418
16879
|
"content": {
|
|
16419
16880
|
"application/json": {
|
|
16420
16881
|
"schema": {
|
|
@@ -16422,9 +16883,9 @@
|
|
|
16422
16883
|
}
|
|
16423
16884
|
}
|
|
16424
16885
|
},
|
|
16425
|
-
"description": "
|
|
16886
|
+
"description": "No such session in your account."
|
|
16426
16887
|
},
|
|
16427
|
-
"
|
|
16888
|
+
"409": {
|
|
16428
16889
|
"content": {
|
|
16429
16890
|
"application/json": {
|
|
16430
16891
|
"schema": {
|
|
@@ -16432,7 +16893,7 @@
|
|
|
16432
16893
|
}
|
|
16433
16894
|
}
|
|
16434
16895
|
},
|
|
16435
|
-
"description": "
|
|
16896
|
+
"description": "The session has already finished."
|
|
16436
16897
|
},
|
|
16437
16898
|
"422": {
|
|
16438
16899
|
"content": {
|
|
@@ -16450,17 +16911,17 @@
|
|
|
16450
16911
|
"HTTPBearer": []
|
|
16451
16912
|
}
|
|
16452
16913
|
],
|
|
16453
|
-
"summary": "
|
|
16914
|
+
"summary": "Stop Agent Session",
|
|
16454
16915
|
"tags": [
|
|
16455
16916
|
"v1"
|
|
16456
16917
|
],
|
|
16457
|
-
"x-ellipsis-sdk-method": "sessions.
|
|
16918
|
+
"x-ellipsis-sdk-method": "sessions.stop"
|
|
16458
16919
|
}
|
|
16459
16920
|
},
|
|
16460
|
-
"/v1/sessions/{session_id}/
|
|
16921
|
+
"/v1/sessions/{session_id}/transcript": {
|
|
16461
16922
|
"post": {
|
|
16462
|
-
"description": "
|
|
16463
|
-
"operationId": "
|
|
16923
|
+
"description": "Append transcript lines to a session's record.\n\nThe in-sandbox tailer for interactive sessions.\n\nA sandbox token may only push its own session's transcript.\nIdempotent by transcript line uuid; tolerant of malformed lines.",
|
|
16924
|
+
"operationId": "ingest_agent_session_transcript",
|
|
16464
16925
|
"parameters": [
|
|
16465
16926
|
{
|
|
16466
16927
|
"in": "path",
|
|
@@ -16488,12 +16949,22 @@
|
|
|
16488
16949
|
}
|
|
16489
16950
|
}
|
|
16490
16951
|
],
|
|
16952
|
+
"requestBody": {
|
|
16953
|
+
"content": {
|
|
16954
|
+
"application/json": {
|
|
16955
|
+
"schema": {
|
|
16956
|
+
"$ref": "#/components/schemas/IngestTranscriptRequest"
|
|
16957
|
+
}
|
|
16958
|
+
}
|
|
16959
|
+
},
|
|
16960
|
+
"required": true
|
|
16961
|
+
},
|
|
16491
16962
|
"responses": {
|
|
16492
16963
|
"200": {
|
|
16493
16964
|
"content": {
|
|
16494
16965
|
"application/json": {
|
|
16495
16966
|
"schema": {
|
|
16496
|
-
"$ref": "#/components/schemas/
|
|
16967
|
+
"$ref": "#/components/schemas/TranscriptIngestResult"
|
|
16497
16968
|
}
|
|
16498
16969
|
}
|
|
16499
16970
|
},
|
|
@@ -16537,7 +17008,7 @@
|
|
|
16537
17008
|
}
|
|
16538
17009
|
}
|
|
16539
17010
|
},
|
|
16540
|
-
"description": "The session has
|
|
17011
|
+
"description": "The session has no execution yet to attach transcript records to."
|
|
16541
17012
|
},
|
|
16542
17013
|
"422": {
|
|
16543
17014
|
"content": {
|
|
@@ -16555,27 +17026,93 @@
|
|
|
16555
17026
|
"HTTPBearer": []
|
|
16556
17027
|
}
|
|
16557
17028
|
],
|
|
16558
|
-
"summary": "
|
|
17029
|
+
"summary": "Ingest Agent Session Transcript",
|
|
16559
17030
|
"tags": [
|
|
16560
17031
|
"v1"
|
|
16561
17032
|
],
|
|
16562
|
-
"x-ellipsis-sdk-method": "sessions.
|
|
17033
|
+
"x-ellipsis-sdk-method": "sessions.ingest_transcript",
|
|
17034
|
+
"x-ellipsis-undocumented": true
|
|
16563
17035
|
}
|
|
16564
17036
|
},
|
|
16565
|
-
"/v1/sessions/
|
|
16566
|
-
"
|
|
16567
|
-
"description": "
|
|
16568
|
-
"operationId": "
|
|
17037
|
+
"/v1/settings/sessions/defaults": {
|
|
17038
|
+
"get": {
|
|
17039
|
+
"description": "Get the account-wide session defaults.\n\nToday one setting: the default model every session falls back to\nwhen neither its request nor its agent config names one.",
|
|
17040
|
+
"operationId": "get_session_defaults",
|
|
16569
17041
|
"parameters": [
|
|
16570
17042
|
{
|
|
16571
|
-
"in": "
|
|
16572
|
-
"name": "
|
|
16573
|
-
"required":
|
|
17043
|
+
"in": "header",
|
|
17044
|
+
"name": "user-agent",
|
|
17045
|
+
"required": false,
|
|
16574
17046
|
"schema": {
|
|
16575
|
-
"
|
|
16576
|
-
|
|
17047
|
+
"anyOf": [
|
|
17048
|
+
{
|
|
17049
|
+
"type": "string"
|
|
17050
|
+
},
|
|
17051
|
+
{
|
|
17052
|
+
"type": "null"
|
|
17053
|
+
}
|
|
17054
|
+
],
|
|
17055
|
+
"title": "User-Agent"
|
|
16577
17056
|
}
|
|
17057
|
+
}
|
|
17058
|
+
],
|
|
17059
|
+
"responses": {
|
|
17060
|
+
"200": {
|
|
17061
|
+
"content": {
|
|
17062
|
+
"application/json": {
|
|
17063
|
+
"schema": {
|
|
17064
|
+
"$ref": "#/components/schemas/SessionDefaults"
|
|
17065
|
+
}
|
|
17066
|
+
}
|
|
17067
|
+
},
|
|
17068
|
+
"description": "Successful Response"
|
|
17069
|
+
},
|
|
17070
|
+
"401": {
|
|
17071
|
+
"content": {
|
|
17072
|
+
"application/json": {
|
|
17073
|
+
"schema": {
|
|
17074
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
17075
|
+
}
|
|
17076
|
+
}
|
|
17077
|
+
},
|
|
17078
|
+
"description": "The bearer token is missing, invalid, or revoked."
|
|
17079
|
+
},
|
|
17080
|
+
"403": {
|
|
17081
|
+
"content": {
|
|
17082
|
+
"application/json": {
|
|
17083
|
+
"schema": {
|
|
17084
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
17085
|
+
}
|
|
17086
|
+
}
|
|
17087
|
+
},
|
|
17088
|
+
"description": "The credential may not perform this action, or the account is blocked."
|
|
16578
17089
|
},
|
|
17090
|
+
"422": {
|
|
17091
|
+
"content": {
|
|
17092
|
+
"application/json": {
|
|
17093
|
+
"schema": {
|
|
17094
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
17095
|
+
}
|
|
17096
|
+
}
|
|
17097
|
+
},
|
|
17098
|
+
"description": "Validation Error"
|
|
17099
|
+
}
|
|
17100
|
+
},
|
|
17101
|
+
"security": [
|
|
17102
|
+
{
|
|
17103
|
+
"HTTPBearer": []
|
|
17104
|
+
}
|
|
17105
|
+
],
|
|
17106
|
+
"summary": "Get Session Defaults",
|
|
17107
|
+
"tags": [
|
|
17108
|
+
"v1"
|
|
17109
|
+
],
|
|
17110
|
+
"x-ellipsis-sdk-method": "settings.sessions.get_defaults"
|
|
17111
|
+
},
|
|
17112
|
+
"put": {
|
|
17113
|
+
"description": "Set the account-wide session defaults.\n\n`model` accepts an alias or canonical id and is stored canonical;\nnull clears it (sessions then fall back to the platform default).\nRefused for sandbox tokens (potentially prompt-injected code must\nnot repoint the account's default model).",
|
|
17114
|
+
"operationId": "put_session_defaults",
|
|
17115
|
+
"parameters": [
|
|
16579
17116
|
{
|
|
16580
17117
|
"in": "header",
|
|
16581
17118
|
"name": "user-agent",
|
|
@@ -16597,7 +17134,7 @@
|
|
|
16597
17134
|
"content": {
|
|
16598
17135
|
"application/json": {
|
|
16599
17136
|
"schema": {
|
|
16600
|
-
"$ref": "#/components/schemas/
|
|
17137
|
+
"$ref": "#/components/schemas/SessionDefaults"
|
|
16601
17138
|
}
|
|
16602
17139
|
}
|
|
16603
17140
|
},
|
|
@@ -16608,23 +17145,13 @@
|
|
|
16608
17145
|
"content": {
|
|
16609
17146
|
"application/json": {
|
|
16610
17147
|
"schema": {
|
|
16611
|
-
"$ref": "#/components/schemas/
|
|
17148
|
+
"$ref": "#/components/schemas/SessionDefaults"
|
|
16612
17149
|
}
|
|
16613
17150
|
}
|
|
16614
17151
|
},
|
|
16615
17152
|
"description": "Successful Response"
|
|
16616
17153
|
},
|
|
16617
|
-
"
|
|
16618
|
-
"content": {
|
|
16619
|
-
"application/json": {
|
|
16620
|
-
"schema": {
|
|
16621
|
-
"$ref": "#/components/schemas/ErrorResponse"
|
|
16622
|
-
}
|
|
16623
|
-
}
|
|
16624
|
-
},
|
|
16625
|
-
"description": "The bearer token is missing, invalid, or revoked."
|
|
16626
|
-
},
|
|
16627
|
-
"403": {
|
|
17154
|
+
"400": {
|
|
16628
17155
|
"content": {
|
|
16629
17156
|
"application/json": {
|
|
16630
17157
|
"schema": {
|
|
@@ -16632,9 +17159,9 @@
|
|
|
16632
17159
|
}
|
|
16633
17160
|
}
|
|
16634
17161
|
},
|
|
16635
|
-
"description": "The
|
|
17162
|
+
"description": "The model id is unknown, internal-only, or not runnable on the Claude Code harness."
|
|
16636
17163
|
},
|
|
16637
|
-
"
|
|
17164
|
+
"401": {
|
|
16638
17165
|
"content": {
|
|
16639
17166
|
"application/json": {
|
|
16640
17167
|
"schema": {
|
|
@@ -16642,9 +17169,9 @@
|
|
|
16642
17169
|
}
|
|
16643
17170
|
}
|
|
16644
17171
|
},
|
|
16645
|
-
"description": "
|
|
17172
|
+
"description": "The bearer token is missing, invalid, or revoked."
|
|
16646
17173
|
},
|
|
16647
|
-
"
|
|
17174
|
+
"403": {
|
|
16648
17175
|
"content": {
|
|
16649
17176
|
"application/json": {
|
|
16650
17177
|
"schema": {
|
|
@@ -16652,7 +17179,7 @@
|
|
|
16652
17179
|
}
|
|
16653
17180
|
}
|
|
16654
17181
|
},
|
|
16655
|
-
"description": "The
|
|
17182
|
+
"description": "The credential may not perform this action, or the account is blocked."
|
|
16656
17183
|
},
|
|
16657
17184
|
"422": {
|
|
16658
17185
|
"content": {
|
|
@@ -16670,11 +17197,11 @@
|
|
|
16670
17197
|
"HTTPBearer": []
|
|
16671
17198
|
}
|
|
16672
17199
|
],
|
|
16673
|
-
"summary": "
|
|
17200
|
+
"summary": "Set Session Defaults",
|
|
16674
17201
|
"tags": [
|
|
16675
17202
|
"v1"
|
|
16676
17203
|
],
|
|
16677
|
-
"x-ellipsis-sdk-method": "sessions.
|
|
17204
|
+
"x-ellipsis-sdk-method": "settings.sessions.set_defaults"
|
|
16678
17205
|
}
|
|
16679
17206
|
},
|
|
16680
17207
|
"/v1/usage": {
|
|
@@ -16746,7 +17273,7 @@
|
|
|
16746
17273
|
"HTTPBearer": []
|
|
16747
17274
|
}
|
|
16748
17275
|
],
|
|
16749
|
-
"summary": "Get Usage
|
|
17276
|
+
"summary": "Get Usage",
|
|
16750
17277
|
"tags": [
|
|
16751
17278
|
"v1"
|
|
16752
17279
|
],
|