Skip to content

Claim

POST
/connector/v1/assignments
Idempotency-Key
required
string
>= 1 characters <= 128 characters /^[A-Za-z0-9_-]+$/

Required once; connector-scoped, retained only when an assignment is created. Empty polls leave the key unused.

X-Connector-Session
required
string format: uuid

Active process ownership session. Session changes do not change claim semantics.

Empty JSON object. FIFO eligibility is server-selected. Unknown fields and query parameters are rejected; 8 KiB maximum body.

Media typeapplication/json

Claim parameters are currently empty: the server selects all work by FIFO eligibility. Process identity is a header and is not semantic claim content.

object

Assignment and running/preparing transition committed. Repeating a successful key returns the original immutable specification.

Media typeapplication/json

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
Cache-Control
string

No-store

Location
string

Assignment detail with the pinned receipt and current state.

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.

No eligible work or outstanding-work allowance. No durable key is consumed.

Cache-Control
string

No-store

Retry-After
string

1 second; use bounded polling.

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, invalid Idempotency-Key or X-Connector-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.

Invalid connector credential, including a write-time revocation check.

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.

An active owned session is required (session_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.

Body exceeds the 8 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.

Claim body must be an empty JSON object.

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.

Coordination unavailable or commit uncertain. Retry the same key; never infer that an assignment did not commit.

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.