Skip to main content

Schemas

Register a version​

POST /v1/schemas

name string required

Schema name, such as support/triage.

version string required

Immutable version tag, such as 0.0.1.

schema object | boolean required

The output schema, including descriptions.

Names use lowercase letters, digits, ., _, - and /; version tags may also contain uppercase letters but no /. Both begin with an alphanumeric character. Names are at most 90 characters; version tags are at most 128. Names may not contain empty, . or .. path segments.

A successful registration returns 201 with schema_id and schema_digest. Illustrative response excerpt:

{"schema_id":"support/triage:0.0.1"}

Versions are immutable. The same content can be registered again; different content at that version returns 409 VERSION_CONFLICT. Invalid names or schemas return 422.

Inspect a schema​

GET /v1/schemas/{reference}

The reference can be a version (support/triage:0.0.1), an alias, or a digest reference of the form support/triage@sha256:<digest>. It must belong to your tenant.

A successful response returns 200 with schema_id, schema_digest and the original schema. An unknown or inaccessible reference returns 404 SCHEMA_NOT_FOUND.

curl --fail-with-body --silent --show-error \
  "https://api.blatent.ai/v1/schemas/support/triage:0.0.1" \
  -H "Authorization: Bearer $BLATENT_API_KEY"

Follow the registration guide for the complete publish-and-resolve sequence.