Get Schema

Get the JSON schema for a given domain (document.invoice, document.receipt, etc).

post/v1/schema

Request

  • Base URL: https://api.vlm.run (the document declares no server; this is the origin it was published from)
  • URL: https://api.vlm.run/v1/schema
  • Auth: HTTP bearer

Request body

domainstring required

The domain to get the schema for (e.g. document.invoice).

Response

Successful Response

domainstring required

The domain to get the schema for.

descriptionstring required

The description of the domain.

schema_versionstring required

The specific version of the schema.

schema_hashstring required

The sha256 hash of the schema.

gql_stmtstring required

The GraphQL statement for the domain.

json_schemaobject required

The JSON schema for the domain.

json_sampleobject nullable

A sample JSON object that matches the schema.

Changes

No recorded changes to this operation across all 2 revisions of this API.