Skip to content

Get assignment

GET
/connector/v1/assignments/{assignment_id}

Retrieve retained work already assigned to this connector, without requiring an active session. The original immutable receipt is separate from current public progress. This read does not grant permission to launch or relaunch the work.

assignment_id
required
string format: uuid

Existing assignment identity.

Original pinned assignment and current state, including after publication or installation revocation.

Media typeapplication/json

Immutable original claim receipt beside current progress. No launch authority. Deliberately omit Debug because the specification contains private inputs.

object
assignment
required

Complete pinned specification. Inputs are private; deliberately omit Debug.

object
assignment_id
required
string format: uuid
attempt_id
required
string format: uuid
connector_id
required
string
context_id
required
string
contract_version
required
integer format: int32
created_at
required
string format: date-time
definition
required

Pinned identities and scientific schemas checked during registration.

Contract validation checks schemas and examples, not scientific correctness. Registration does not activate a publication or verify the claimed identities.

object
contract_version
required

Enumeray’s interpretation of schema restrictions and input/output values. This is independent of the wrapper protocol and JSON Schema dialect.

integer format: int32
dataset_identities
required
Array<string>
examples
required
Array<object>

A named example validated at registration and preserved for discovery.

object
inputs
required
name
required
string
outputs
input_schema
required
log_files

Up to eight optional diagnostics, keyed by [a-z][a-z0-9_-]{0,63}. Paths are confined to the run workspace; diagnostics are independent of results.

object
key
additional properties
object
path
required
string
>= 1 characters <= 1024 characters
model_identity
required
string
output_schema
required
runtime_identity
required
string
wrapper_identity
required
string
wrapper_protocol_version
required
integer format: int32
descriptor
required

Internal registration snapshot used by connector configuration and execution evidence.

object
entrypoint
required

First argument is an executable path relative to release_path.

Array<string>
environment
object
key
additional properties
string
installation
required

Identity claims derived from the retained scientific definition. They do not independently attest the provider’s installed software.

object
dataset_identities
required
Array<string>
model_identity
required
string
runtime_identity
required
string
wrapper_identity
required
string
wrapper_protocol_version
required
integer format: int32
provider_binding_id
required
string
release_path
required
string
slurm_script

Model-supplied batch file relative to release_path; required for Slurm.

string | null
inputs
required
journal_id
required
string format: uuid
model_id
required
string
publication_id
required

Immutable accepted publication and execution context.

string
requirements
required

Requirements derived from an immutable context and scientific contract. These are execution needs, not observations of backend support.

object
capabilities
required
Array<string>
Allowed values: json_inputs json_outputs artifact_inputs artifact_outputs large_artifacts collection_inputs collection_outputs
driver
required

Execution mechanisms, independent of the wrapper’s request/result protocol.

string
Allowed values: process slurm
wrapper_protocol_version
required
integer format: int32
run_id
required
string format: uuid
storage_destination_id

Pinned at acceptance; omitted from historical receipts.

string | null
backend_handle
One of:
null
delivery_completion
One of:
null
last_event_sequence

Greatest accepted event sequence, including diagnostic-only events.

integer | null format: int64
last_observed_at

API receipt time of the latest qualifying execution observation.

string | null format: date-time
observation_freshness
required

API confirmation age: fresh below 60 seconds, stale at or above 60 seconds. Missing or future confirmation times are unknown.

string
Allowed values: unknown fresh stale
phase
One of:
null
resolution
One of:
null
result
One of:
null
state
required

Public execution state. Delegated preparation and collection are running.

string
Allowed values: queued running succeeded failed cancelled
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.

Query parameters are not accepted. Code bad_request.

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, rechecked while holding the connector lock.

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 identity is invalid, absent, or belongs to 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.

413: the request body exceeds the configured size 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.

Assignment inspection is temporarily unavailable.

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.