Get Schema

Retrieve a saved extraction schema by UUID or SCH- short ID. Returns the normalized JSON Schema definition, field count, and links to related extractions.

The GET /v1/schemas/:id endpoint retrieves the full details of a single saved extraction schema: its normalized JSON Schema definition, field count, and links to the extractions that used it. Use it to inspect a schema before running extractions or to verify that an update was applied correctly.

Response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "short_id": "SCH-A1B2C3D4",
  "name": "Invoice",
  "description": "Standard invoice extraction schema",
  "definition": {
    "type": "object",
    "properties": {
      "invoice_number": { "type": "string", "title": "invoice_number", "description": "Unique invoice identifier" },
      "vendor": { "type": "string", "title": "vendor" },
      "total": { "type": "number", "title": "total" },
      "date": { "type": "date", "title": "date" }
    },
    "required": ["invoice_number"]
  },
  "field_count": 4,
  "version": 1,
  "created_at": "2024-08-20T14:00:00.000Z",
  "updated_at": "2024-09-10T09:15:00.000Z",
  "links": {
    "self": "/v1/schemas/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "extractions": "/v1/extractions?schema_id=a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "dashboard": "https://app.talonic.com/schemas/user/a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
}

Most integrations call this endpoint before running an extraction to verify the schema definition is correct, or after an update to confirm the new version was applied. A typical workflow is to create a schema with POST /v1/schemas, store the returned id, then fetch it here whenever you need the current definition.

The response includes the full definition object in normalized JSON Schema format, along with the field_count. Use the links.extractions URL to list all extractions that used this schema, and links.dashboard to open it in the platform UI.

Pair this with PUT /v1/schemas/:id to update the definition, or pass the id as schema_id on POST /v1/extract to run schema-driven extraction. For version history, diffs, and rollback, use the versions endpoints under GET /v1/schemas/:id/versions.

Errors