forked from Div99/agent-protocol
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yml
581 lines (581 loc) · 16.7 KB
/
openapi.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
openapi: 3.0.1
info:
title: Agent Protocol
description: Specification of the API protocol for communication with an agent.
version: v1
servers:
- url: 'http://0.0.0.0:8000'
description: Agent Protocol API
paths:
/ap/v1/agent/tasks:
post:
operationId: createAgentTask
summary: Creates a task for the agent.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TaskRequestBody'
responses:
'200':
description: A new agent task was successfully created.
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
x-postman-variables:
- type: save
name: task_id
path: .task_id
'422':
$ref: '#/components/responses/UnprocessableEntity'
default:
description: Internal Server Error
tags:
- agent
get:
operationId: listAgentTasks
summary: List all tasks that have been created for the agent.
parameters:
- name: current_page
in: query
description: Page number
required: false
schema:
type: integer
format: int32
default: 1
minimum: 1
example: 2
- name: page_size
in: query
description: Number of items per page
required: false
schema:
type: integer
format: int32
default: 10
minimum: 1
example: 25
responses:
'200':
description: Returned list of agent's tasks.
content:
application/json:
schema:
$ref: '#/components/schemas/TaskListResponse'
default:
description: Internal Server Error
tags:
- agent
'/ap/v1/agent/tasks/{task_id}':
get:
operationId: getAgentTask
summary: Get details about a specified agent task.
parameters:
- name: task_id
in: path
description: ID of the task
required: true
schema:
type: string
example: 1d5a533e-3904-4401-8a07-c49adf88b981
x-postman-variables:
- type: load
name: task_id
responses:
'200':
description: Returned details about an agent task.
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
'404':
$ref: '#/components/responses/NotFound'
default:
description: Internal Server Error
tags:
- agent
'/ap/v1/agent/tasks/{task_id}/steps':
get:
operationId: listAgentTaskSteps
summary: List all steps for the specified task.
parameters:
- name: task_id
in: path
description: ID of the task.
required: true
schema:
type: string
example: 50da533e-3904-4401-8a07-c49adf88b5eb
x-postman-variables:
- type: load
name: task_id
- name: current_page
in: query
description: Page number
required: false
schema:
type: integer
format: int32
default: 1
minimum: 1
example: 2
- name: page_size
in: query
description: Number of items per page
required: false
schema:
type: integer
format: int32
default: 10
minimum: 1
example: 25
responses:
'200':
description: Returned list of agent's steps for the specified task.
content:
application/json:
schema:
$ref: '#/components/schemas/TaskStepsListResponse'
'404':
$ref: '#/components/responses/NotFound'
default:
description: Internal Server Error
tags:
- agent
post:
operationId: executeAgentTaskStep
summary: Execute a step in the specified agent task.
parameters:
- name: task_id
in: path
description: ID of the task
required: true
schema:
type: string
example: 50da533e-3904-4401-8a07-c49adf88b5eb
x-postman-variables:
- type: load
name: task_id
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StepRequestBody'
responses:
'200':
description: Executed step for the agent task.
content:
application/json:
schema:
$ref: '#/components/schemas/Step'
x-postman-variables:
- type: save
name: step_id
path: .step_id
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
default:
description: Internal Server Error
tags:
- agent
'/ap/v1/agent/tasks/{task_id}/steps/{step_id}':
get:
operationId: getAgentTaskStep
summary: Get details about a specified task step.
parameters:
- name: task_id
in: path
description: ID of the task
required: true
schema:
type: string
example: 50da533e-3904-4401-8a07-c49adf88b5eb
x-postman-variables:
- type: load
name: task_id
- type: load
name: step_id
- name: step_id
in: path
description: ID of the step
required: true
schema:
type: string
example: 28ca533e-3904-4401-8a07-c49adf8891c2
x-postman-variables:
- type: load
name: step_id
responses:
'200':
description: Returned details about an agent task step.
content:
application/json:
schema:
$ref: '#/components/schemas/Step'
'404':
$ref: '#/components/responses/NotFound'
default:
description: Internal Server Error
tags:
- agent
'/ap/v1/agent/tasks/{task_id}/artifacts':
get:
operationId: listAgentTaskArtifacts
summary: List all artifacts that have been created for the given task.
parameters:
- name: task_id
in: path
description: ID of the task
required: true
schema:
type: string
example: 50da533e-3904-4401-8a07-c49adf88b5eb
x-postman-variables:
- type: load
name: task_id
- name: current_page
in: query
description: Page number
required: false
schema:
type: integer
format: int32
default: 1
minimum: 1
example: 2
- name: page_size
in: query
description: Number of items per page
required: false
schema:
type: integer
format: int32
default: 10
minimum: 1
example: 25
responses:
'200':
description: Returned the list of artifacts for the task.
content:
application/json:
schema:
$ref: '#/components/schemas/TaskArtifactsListResponse'
'404':
$ref: '#/components/responses/NotFound'
default:
description: Internal Server Error
tags:
- agent
post:
operationId: uploadAgentTaskArtifacts
summary: Upload an artifact for the specified task.
parameters:
- name: task_id
in: path
description: ID of the task
required: true
schema:
type: string
example: 50da533e-3904-4401-8a07-c49adf88b5eb
x-postman-variables:
- type: load
name: task_id
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/ArtifactUpload'
responses:
'200':
description: Returned the content of the artifact.
content:
application/json:
schema:
$ref: '#/components/schemas/Artifact'
'404':
$ref: '#/components/responses/NotFound'
default:
description: Internal Server Error
tags:
- agent
'/ap/v1/agent/tasks/{task_id}/artifacts/{artifact_id}':
get:
operationId: downloadAgentTaskArtifact
summary: Download a specified artifact.
parameters:
- name: task_id
in: path
description: ID of the task
required: true
schema:
type: string
example: 50da533e-3904-4401-8a07-c49adf88b5eb
x-postman-variables:
- type: load
name: task_id
- name: artifact_id
in: path
description: ID of the artifact
required: true
schema:
type: string
example: 1e41533e-3904-4401-8a07-c49adf8893de
responses:
'200':
description: Returned the content of the artifact.
content:
application/octet-stream:
schema:
type: string
format: binary
'404':
$ref: '#/components/responses/NotFound'
default:
description: Internal Server Error
tags:
- agent
components:
schemas:
Pagination:
type: object
properties:
total_items:
description: Total number of items.
type: integer
example: 42
total_pages:
description: Total number of pages.
type: integer
example: 97
current_page:
description: Current_page page number.
type: integer
example: 1
page_size:
description: Number of items per page.
type: integer
example: 25
required:
- total_items
- total_pages
- current_page
- page_size
TaskListResponse:
type: object
properties:
tasks:
type: array
items:
$ref: '#/components/schemas/Task'
pagination:
$ref: '#/components/schemas/Pagination'
required:
- tasks
- pagination
TaskStepsListResponse:
type: object
properties:
steps:
type: array
items:
$ref: '#/components/schemas/Step'
pagination:
$ref: '#/components/schemas/Pagination'
required:
- steps
- pagination
TaskArtifactsListResponse:
type: object
properties:
artifacts:
type: array
items:
$ref: '#/components/schemas/Artifact'
pagination:
$ref: '#/components/schemas/Pagination'
required:
- artifacts
- pagination
TaskInput:
description: Input parameters for the task. Any value is allowed.
type: object
example: |-
{
"debug": false,
"mode": "benchmarks"
}
Artifact:
description: An Artifact either created by or submitted to the agent.
type: object
properties:
artifact_id:
description: ID of the artifact.
type: string
example: b225e278-8b4c-4f99-a696-8facf19f0e56
agent_created:
description: Whether the artifact has been created by the agent.
type: boolean
example: false
file_name:
description: Filename of the artifact.
type: string
example: main.py
relative_path:
description: Relative path of the artifact in the agent's workspace.
type: string
example: python/code/
nullable: true
required:
- artifact_id
- agent_created
- file_name
ArtifactUpload:
description: Artifact to upload to the agent.
type: object
properties:
file:
description: File to upload.
type: string
format: binary
example: binary representation of file
relative_path:
description: Relative path of the artifact in the agent's workspace.
type: string
example: python/code
required:
- file
StepInput:
description: Input parameters for the task step. Any value is allowed.
type: object
example: |-
{
"file_to_refactor": "models.py"
}
StepOutput:
description: Output that the task step has produced. Any value is allowed.
type: object
example: |-
{
"tokens": 7894,
"estimated_cost": "0,24$"
}
nullable: true
TaskRequestBody:
description: Body of the task request.
type: object
properties:
input:
description: Input prompt for the task.
type: string
example: Write 'Washington' to the file 'output.txt'.
nullable: true
additional_input:
$ref: '#/components/schemas/TaskInput'
Task:
allOf:
- $ref: '#/components/schemas/TaskRequestBody'
- type: object
description: Definition of an agent task.
required:
- task_id
- artifacts
properties:
task_id:
description: The ID of the task.
type: string
example: 50da533e-3904-4401-8a07-c49adf88b5eb
artifacts:
description: A list of artifacts that the task has produced.
type: array
items:
$ref: '#/components/schemas/Artifact'
example:
- 7a49f31c-f9c6-4346-a22c-e32bc5af4d8e
- ab7b4091-2560-4692-a4fe-d831ea3ca7d6
default: []
StepRequestBody:
description: Body of the task request.
type: object
properties:
input:
description: Input prompt for the step.
type: string
example: Write the words you receive to the file 'output.txt'.
nullable: true
additional_input:
$ref: '#/components/schemas/StepInput'
Step:
allOf:
- $ref: '#/components/schemas/StepRequestBody'
- type: object
required:
- step_id
- task_id
- status
- is_last
- artifacts
properties:
task_id:
description: The ID of the task this step belongs to.
type: string
example: 50da533e-3904-4401-8a07-c49adf88b5eb
step_id:
description: The ID of the task step.
type: string
example: 6bb1801a-fd80-45e8-899a-4dd723cc602e
name:
description: The name of the task step.
type: string
example: Write to file
nullable: true
status:
description: The status of the task step.
type: string
example: created
enum:
- created
- running
- completed
output:
description: Output of the task step.
type: string
example: "I am going to use the write_to_file command and write Washington to a file called output.txt <write_to_file('output.txt', 'Washington')"
nullable: true
additional_output:
$ref: '#/components/schemas/StepOutput'
artifacts:
description: A list of artifacts that the step has produced.
type: array
items:
$ref: '#/components/schemas/Artifact'
default: []
is_last:
description: Whether this is the last step in the task.
type: boolean
example: true
default: false
responses:
UnprocessableEntity:
description: Unable to process request. Likely due to improperly formatted request.
content:
application/json:
schema:
description: A generic JSON object without any specific requirements.
type: object
NotFound:
description: Unable to find entity with a given identifier
content:
application/json:
schema:
type: object
properties:
message:
description: Message stating the entity was not found
type: string
example: Unable to find entity with the provided id
required:
- message