Discover models and obtain access

Role: Model user. Prerequisites: Login to the intended API. Files: None for discovery; invitation acceptance uses a privately supplied token.

Read the offering

enumeray model list
enumeray model get example

The catalogue shows IDs, names and descriptions; model get shows access, availability, schemas, examples and the full execution disclosure. Collection commands fetch one page. Use model list --limit 20 and follow the printed Next page command when more models exist.

Replace example with a model ID from the catalogue or one supplied by its owner. Read the scientific description, scientific contract, input/output schemas, examples and execution disclosure before choosing inputs. Availability is advisory: acceptance rechecks access, publication/installation revocation and execution eligibility. A model can be discoverable without a runnable current publication.

Visibility and access are independent. listed offerings appear in ordinary discovery; unlisted offerings can still be accessed by authorized people who know their IDs. Access modes are open, request and invite. An explicit user block takes precedence even for an open model.

Request approval

For a model with request-based access:

enumeray access request example --message 'I need this model for my analysis.'

The model owner reviews the request and decides whether to approve it. Recheck model get example after approval. Being able to view metadata does not by itself grant execution access. If the account is blocked or suspended, contact the responsible administrator rather than issuing new credentials.

You can inspect your own request status and withdraw your own pending request:

enumeray access requests example
# Optional, if you no longer want access; use your request's actual ID:
enumeray access decide example REQUEST_ID withdrawn

Model administrators see all requests for the model; ordinary users see their own. Only the requester can withdraw their request. With a scoped script token, withdrawal requires runs:create; owner approval/rejection requires access:manage plus model administration.

Save the account UUID from enumeray auth whoami when asking the owner for access. The owner uses their own account to list requests and approve your request ID:

# Model owner or co-admin, after reading the request:
enumeray access requests example
enumeray access decide example REQUEST_ID approved

REQUEST_ID is the returned request identifier, not your account UUID. A request does not start a run. After approval, review the publication and initialize an analysis directory with analysis init.

Accept an invitation

The owner can invite a user UUID or a verified email recipient. Obtain the recipient-bound token through the owner’s chosen channel. Supply the token value to:

enumeray access accept example

This command reads the token from stdin; do not put it in an argument. If the owner gives you a private invitation JSON file, extract its invitation token rather than feeding the whole JSON document. Acceptance must be performed by the intended recipient. Email invitations depend on the identity provider’s verified email claim.

With the owner’s saved invitation.json and jq installed, accept it without putting the token in shell history:

jq -er '.token' invitation.json | enumeray access accept example
enumeray model get example

Use the recipient’s authenticated profile for acceptance. An unaccepted expired invitation or a wrong-recipient invitation needs the model owner’s attention. The same recipient can retry an already accepted token to recover its acceptance receipt, including after expiry; that retry does not restore subsequently revoked access. Accepting the invitation authorizes model access; it does not create a compute grant or make you a model administrator.

Inspect historical contracts

The HTTP API exposes the current publication and scientific definition through /api/v1/models/{model_id}. Publication history and candidate inspection require model administration. Accepted runs retain their original publication and provenance. Use the HTTP reference for access rules.

Expected outcome: Model discovery exposes an accessible current publication, execution location and scientific-data access disclosure. Next: Prepare your run. For unexplained access failures, see access troubleshooting.