Skip to content

docs: document run result and batch API endpoints #3121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
isshaddad merged 6 commits into from
Feb 24, 2026
Merged

docs: document run result and batch API endpoints #3121

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1436008
added GET /api/v1/runs/{runId}/result docs
isshaddad Feb 24, 2026
4e62c4b
added POST /api/v1/tasks/{taskId}/batch docs
isshaddad Feb 24, 2026
b953966
added GET /api/v1/batches/{batchId} docs
isshaddad Feb 24, 2026
d4b9e85
added GET /api/v1/batches/{batchId}/results docs
isshaddad Feb 24, 2026
c5d43d8
coderabbit reviews
isshaddad Feb 24, 2026
52b79c0
more coderabbit changes
isshaddad Feb 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,11 +239,11 @@
},
{
"group": "Tasks API",
"pages": ["management/tasks/trigger", "management/tasks/batch-trigger"]
"pages": ["management/tasks/trigger", "management/tasks/batch-trigger", "management/tasks/trigger-batch"]
},
{
"group": "Batches API",
"pages": ["management/batches/create", "management/batches/stream-items"]
"pages": ["management/batches/create", "management/batches/retrieve", "management/batches/retrieve-results", "management/batches/stream-items"]
},
{
"group": "Runs API",
Expand All @@ -256,7 +256,8 @@
"management/runs/update-metadata",
"management/runs/add-tags",
"management/runs/retrieve-events",
"management/runs/retrieve-trace"
"management/runs/retrieve-trace",
"management/runs/retrieve-result"
]
},
{
Expand Down
4 changes: 4 additions & 0 deletions docs/management/batches/retrieve-results.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "Retrieve batch results"
openapi: "v3-openapi GET /api/v1/batches/{batchId}/results"
---
4 changes: 4 additions & 0 deletions docs/management/batches/retrieve.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "Retrieve a batch"
openapi: "v3-openapi GET /api/v1/batches/{batchId}"
---
4 changes: 4 additions & 0 deletions docs/management/runs/retrieve-result.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "Retrieve run result"
openapi: "v3-openapi GET /api/v1/runs/{runId}/result"
---
4 changes: 4 additions & 0 deletions docs/management/tasks/trigger-batch.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "Trigger task batch"
openapi: "v3-openapi POST /api/v1/tasks/{taskId}/batch"
---
Loading