Stage an item submission
const url = 'https://example.com/api/v1/org/example/ws/example/projects/example/items/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/submission-stages';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"action_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","provenance":{"capability_name":"example","capability_version":"example","current_task_id":"example","platform_session_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","root_run_id":"example","runtime_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","span_id":"example","trace_id":"example"}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/v1/org/example/ws/example/projects/example/items/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/submission-stages \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "action_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "provenance": { "capability_name": "example", "capability_version": "example", "current_task_id": "example", "platform_session_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "root_run_id": "example", "runtime_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "span_id": "example", "trace_id": "example" } }'Create or return the active agent stage for one item and action.
Authorizations
Section titled “Authorizations”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters”Organization slug
Organization slug
Workspace slug
Workspace slug
Project slug or UUID
Project slug or UUID
Request Bodyrequired
Section titled “Request Bodyrequired”object
object
Examplegenerated
{ "action_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "provenance": { "capability_name": "example", "capability_version": "example", "current_task_id": "example", "platform_session_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "root_run_id": "example", "runtime_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "span_id": "example", "trace_id": "example" }}Responses
Section titled “ Responses ”Successful Response
object
object
Example
{ "status": "staged"}Invalid request
Canonical API error envelope returned by the API.
object
HTTP status code
Human-readable error message
object
Where the validation error occurred
Human-readable validation message
Machine-readable validation error type
Stable machine-readable error type
Example
{ "code": 401, "detail": "Authentication failed", "type": "authentication_error"}Authentication failed
Canonical API error envelope returned by the API.
object
HTTP status code
Human-readable error message
object
Where the validation error occurred
Human-readable validation message
Machine-readable validation error type
Stable machine-readable error type
Example
{ "code": 401, "detail": "Authentication failed", "type": "authentication_error"}Access forbidden
Canonical API error envelope returned by the API.
object
HTTP status code
Human-readable error message
object
Where the validation error occurred
Human-readable validation message
Machine-readable validation error type
Stable machine-readable error type
Example
{ "code": 401, "detail": "Authentication failed", "type": "authentication_error"}Not found
Canonical API error envelope returned by the API.
object
HTTP status code
Human-readable error message
object
Where the validation error occurred
Human-readable validation message
Machine-readable validation error type
Stable machine-readable error type
Example
{ "code": 401, "detail": "Authentication failed", "type": "authentication_error"}Already exists
Canonical API error envelope returned by the API.
object
HTTP status code
Human-readable error message
object
Where the validation error occurred
Human-readable validation message
Machine-readable validation error type
Stable machine-readable error type
Example
{ "code": 401, "detail": "Authentication failed", "type": "authentication_error"}Validation error
Canonical API error envelope returned by the API.
object
HTTP status code
Human-readable error message
object
Where the validation error occurred
Human-readable validation message
Machine-readable validation error type
Stable machine-readable error type
Example
{ "code": 401, "detail": "Authentication failed", "type": "authentication_error"}Upgrade required
Canonical API error envelope returned by the API.
object
HTTP status code
Human-readable error message
object
Where the validation error occurred
Human-readable validation message
Machine-readable validation error type
Stable machine-readable error type
Example
{ "code": 401, "detail": "Authentication failed", "type": "authentication_error"}Rate limited
Canonical API error envelope returned by the API.
object
HTTP status code
Human-readable error message
object
Where the validation error occurred
Human-readable validation message
Machine-readable validation error type
Stable machine-readable error type
Example
{ "code": 401, "detail": "Authentication failed", "type": "authentication_error"}Internal server error
Canonical API error envelope returned by the API.
object
HTTP status code
Human-readable error message
object
Where the validation error occurred
Human-readable validation message
Machine-readable validation error type
Stable machine-readable error type
Example
{ "code": 401, "detail": "Authentication failed", "type": "authentication_error"}Bad gateway
Canonical API error envelope returned by the API.
object
HTTP status code
Human-readable error message
object
Where the validation error occurred
Human-readable validation message
Machine-readable validation error type
Stable machine-readable error type
Example
{ "code": 401, "detail": "Authentication failed", "type": "authentication_error"}Gateway timeout
Canonical API error envelope returned by the API.
object
HTTP status code
Human-readable error message
object
Where the validation error occurred
Human-readable validation message
Machine-readable validation error type
Stable machine-readable error type
Example
{ "code": 401, "detail": "Authentication failed", "type": "authentication_error"}