Skip to content

Register a model installation using a current compute grant; connector validation determines readiness.

POST
/api/v1/models/{model_id}/publications
model_id
required
string
Media typeapplication/json
object
context_id
required
string
<= 64 characters /^[a-z][a-z0-9_-]{0,63}$/
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
object
entrypoint
required

Executable relative to release_path followed by fixed arguments.

Array<string>
>= 1 items <= 32 items
environment
object
<= 32 properties
key
additional properties
string
release_path
required

Absolute immutable release-specific path below an allowed installation root. Compute authorization and installation keys are resolved by registration.

string
<= 4096 characters
slurm_script

Model-owned batch file relative to release_path; required for Slurm, omitted for process.

string | null
>= 1 characters <= 4096 characters
id
required
string
<= 64 characters /^[a-z][a-z0-9_-]{0,63}$/

Register a model installation using a current compute grant; connector validation determines readiness.

Media typeapplication/json
object
generation
integer | null format: int64
id
required
string
status
required
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.

Malformed 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.

Valid active credential required; connector and user credentials are separate.

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.

The token does not permit this operation.

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.

Resource absent or outside the caller’s authority.

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.

Concurrent generation/publication change, conflicting retry, or a publication awaiting connector validation.

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.

Request fields, manifest, installation policy, or limits are invalid.

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.

Authentication, identity provider, or management state 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.