OpenAPI schema

Every API key can download an OpenAPI 3.1 document describing exactly the API surface that key can use — its resources, readable and writable fields, supported write actions, and identifier modes.

curl https://actions.einblick.xyz/api/v1/schema \
  -H "Authorization: Bearer api_YOUR_KEY" \
  -o einblick-openapi.json

/api/v1/openapi and /api/v1/openapi.json are aliases of the same endpoint. The response content type is application/vnd.oai.openapi+json.

What's inside

• One tag and path set per accessible resource: list, get, and — where granted — create, update, and delete operations.
• Component schemas per resource: …Attributes (readable fields), …WritableAttributes (create), …UpdateWritableAttributes (update), and full request/response document schemas.
• Shared schemas for assets (EinblickAsset), relation references (EinblickRelationRef), rich text (EinblickRichTextDocument), field metadata, and JSON:API error documents.
• Einblick-specific extensions under x-einblick (per-operation action, source type, resource slug, and identifier modes).

Generating a typed client

The document works with standard OpenAPI tooling, for example openapi-typescript:

npx openapi-typescript einblick-openapi.json -o einblick-api.d.ts

Regenerate the client whenever the key's grants change — the schema is a live reflection of the key, not a static contract.

Interactive reference

The interactive reference renders this same document in the browser. Paste an API key there to explore your exact API surface and send test requests without writing any code.