Skip to content

Put result

PUT
/connector/v1/assignments/{assignment_id}/result

Commit a confirmed terminal outcome for this assignment. Persist the assignment identity and complete body before sending. Identical semantic retries return the original immutable receipt, including after process recovery or terminal completion. JSON object order and decimal spelling do not affect identity. Success requires collecting_results or uploading_results and schema-valid outputs. Every declared file value requires a matching manifest entry naming a ready verified artifact produced by this assignment. Optional file failures are reported separately. Failure requires explicit termination confirmation and bounded failure details. Provider cleanup is acknowledged only after the result, artifact pins and terminal state commit; uncertain transfer remains outstanding without repeating computation.

assignment_id
required
string format: uuid

Owned assignment; singleton operation identity.

X-Connector-Session
required
string format: uuid

Required active process session for the assignment’s durable journal.

Strict JSON object, at most 64 KiB or configured request limit, also bounded after decimal expansion. Duplicate fields at any depth and unknown fields are rejected. files maps declared names to canonical non-nil artifact_id references exactly matching outputs. execution_terminated must be true; absence of contact is insufficient. Outputs and explicit optional-output failures have distinct meanings.

Media typeapplication/json
object
attempt_id
required
string format: uuid
collections
object
key
additional properties

Closed immutable collection reference used by scientific inputs and results.

object
collection_id
required
string format: uuid
/^(?!00000000-0000-0000-0000-000000000000$)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/
execution_terminated
required

Required true: execution has definitely stopped (or never started). Lost contact or an uncertain submission acknowledgement cannot assert this.

boolean
failure
One of:
null
files
required

Declared file names mapped to {artifact_id}, matching outputs exactly. Each artifact must be verified, ready and produced by this assignment.

object
key
additional properties

Closed public stored-file reference, never a path or transfer capability.

object
artifact_id
required
string format: uuid
/^(?!00000000-0000-0000-0000-000000000000$)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/
optional_output_failures
required
object
key
additional properties

Private bounded failure details, never included in diagnostics or tracing.

object
code
required
string
>= 1 characters <= 64 characters /^[a-z][a-z0-9_]*$/
message
required

At most 2048 UTF-8 bytes. Only tab and newline control characters allowed.

string
>= 1 characters <= 2048 characters
outcome
required
string
Allowed values: succeeded failed cancelled
outputs
required

Schema-valid output values, including declared file artifact references.

Result, verified file pins and terminal state committed, or original immutable receipt replayed. provider_cleanup_acknowledged permits removal of provider work files only.

Media typeapplication/json

Original committed acknowledgement, independent of later inspection time.

object
assignment_id
required
string format: uuid
attempt_id
required
string format: uuid
completed_at
required
string format: date-time
outcome
required
string
Allowed values: succeeded failed cancelled
provider_cleanup_acknowledged

True only after this result and every file pin have committed. It permits removal of provider work files, never deletion of API-retained artifacts. Historical receipts and operator resolutions carry no cleanup authority.

boolean
run_id
required
string format: uuid
Cache-Control
string

No-store

x-request-id
string

Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.

Malformed JSON, query parameters, or invalid_session_header.

Media typeapplication/json

The common JSON body for errors returned by the HTTP application.

object
code
required

Stable machine-readable error code.

string
details
One of:
null
message
required

Safe explanation without internal errors or submitted input values.

string
request_id
required

Matches the response’s x-request-id header.

string
Cache-Control
string

No-store

x-request-id
string

Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.

Active connector credential required and rechecked before persistence.

Media typeapplication/json

The common JSON body for errors returned by the HTTP application.

object
code
required

Stable machine-readable error code.

string
details
One of:
null
message
required

Safe explanation without internal errors or submitted input values.

string
request_id
required

Matches the response’s x-request-id header.

string
Cache-Control
string

No-store

WWW-Authenticate
string

Bearer

x-request-id
string

Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.

Assignment invalid, absent or owned by another connector. Code not_found.

Media typeapplication/json

The common JSON body for errors returned by the HTTP application.

object
code
required

Stable machine-readable error code.

string
details
One of:
null
message
required

Safe explanation without internal errors or submitted input values.

string
request_id
required

Matches the response’s x-request-id header.

string
Cache-Control
string

No-store

x-request-id
string

Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.

Result_conflict, attempt_conflict, invalid_transition, session_required or journal_conflict.

Media typeapplication/json

The common JSON body for errors returned by the HTTP application.

object
code
required

Stable machine-readable error code.

string
details
One of:
null
message
required

Safe explanation without internal errors or submitted input values.

string
request_id
required

Matches the response’s x-request-id header.

string
Cache-Control
string

No-store

x-request-id
string

Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.

Body exceeds the 64 KiB or configured limit.

Media typeapplication/json

The common JSON body for errors returned by the HTTP application.

object
code
required

Stable machine-readable error code.

string
details
One of:
null
message
required

Safe explanation without internal errors or submitted input values.

string
request_id
required

Matches the response’s x-request-id header.

string
Cache-Control
string

No-store

x-request-id
string

Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.

JSON content type required.

Media typeapplication/json

The common JSON body for errors returned by the HTTP application.

object
code
required

Stable machine-readable error code.

string
details
One of:
null
message
required

Safe explanation without internal errors or submitted input values.

string
request_id
required

Matches the response’s x-request-id header.

string
Cache-Control
string

No-store

x-request-id
string

Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.

Invalid_request for unsupported structure or bounds; invalid_outputs for pinned output-schema or optional failure declaration mismatch.

Media typeapplication/json

The common JSON body for errors returned by the HTTP application.

object
code
required

Stable machine-readable error code.

string
details
One of:
null
message
required

Safe explanation without internal errors or submitted input values.

string
request_id
required

Matches the response’s x-request-id header.

string
Cache-Control
string

No-store

x-request-id
string

Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.

Assignment_unavailable or assignment_uncertain. Retry the same assignment identity and saved body.

Media typeapplication/json

The common JSON body for errors returned by the HTTP application.

object
code
required

Stable machine-readable error code.

string
details
One of:
null
message
required

Safe explanation without internal errors or submitted input values.

string
request_id
required

Matches the response’s x-request-id header.

string
Cache-Control
string

No-store

x-request-id
string

Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.

An HTTP request failed; inspect the stable error code and request ID.

Media typeapplication/json

The common JSON body for errors returned by the HTTP application.

object
code
required

Stable machine-readable error code.

string
details
One of:
null
message
required

Safe explanation without internal errors or submitted input values.

string
request_id
required

Matches the response’s x-request-id header.

string
Cache-Control
string

No-store

x-request-id
string

Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.

Documentation 205dcb3116ea · public sources 8c70356d340f · built .Download documentation identity.