Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
Skip to Content
PricingDashboard
GuidesAPI ReferenceCLI
API ReferenceInferenceModel Imports

List an organization's model import credentials

The credentials the organization's model imports read their sources with: name, type and a hint to tell two apart, never a secret. An s3_role also shows what the customer's role must trust, and a gcs_federation what the customer's pool must admit.

Required permission

Requires the importcredential.read permission. See Permissions for the roles and API key permissions that include it.

Command line

The orl CLI wraps this endpoint:

orl imports credential list
GET
/v1/inference/credentials

Authorization

apiKey
headerAuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer or_… (legacy vl_… keys still work).

Query Parameters

limit?integer
Range1 <= value <= 200
cursor?string

Response Body

Credentials

application/json
  1. response
items*array<>
nextCursor?string
Example Request
curl -X GET 'https://api.openrelay.inc/v1/inference/credentials'
Example Response
{  "items": [    {      "id": "string",      "orgId": "string",      "type": "hf_token",      "name": "string",      "hint": "string",      "s3Role": {        "roleArn": "string",        "externalId": "string",        "trustPrincipal": "string"      },      "gcsFederation": {        "audience": "string",        "serviceAccount": "string",        "awsAccount": "string",        "subject": "string",        "attributeCondition": "string"      },      "createdAt": "2019-08-24T14:15:22Z"    }  ],  "nextCursor": "string"}

Get a model artifact GET

One of your organization's model artifacts: its architecture, dtype, quantization, size, and the hardware it was found to fit or refused. Another organization's artifact reads as not found.

Create a model import credential POST

Saves a credential your model imports read a private source with: a Hugging Face token, an S3 role or key pair, or a Google Cloud credential. A Google Cloud credential is a workload identity pool provider or a service account key. A secret is sealed with a key only the organization's import sessions can use, and is never returned. An s3_role answers with the external id issued for it and the role its trust policy must admit; a gcs_federation with the subject its pool must admit. A field the type does not take, or a malformed secret, answers 400. An organization holds at most 50, and a role or pool provider another organization registered answers 409 CREDENTIAL_CLAIMED.