Perception

Get a saved extraction schema

Other errors (500, 502, 503) are on Errors.

GET
/v1/extraction-schemas/{id}

Other errors (500, 502, 503) are on Errors.

Authorization

bearerAuth
AuthorizationBearer <token>

Your API key, sent as Authorization: Bearer nace_sk_...

  • Where: the dashboard's API Keys page. It is shown once, when you create it.
  • Format: nace_sk_ followed by 43 URL-safe characters (A-Z, a-z, 0-9, _ and -).
  • Limit: an account can hold at most 3 active keys.
  • Wrong or missing key: returns 401 authentication_error.

In: header

Path Parameters

idstringrequired

The schema's schema_id (sch_...). An id longer than 128 characters answers 404 with code not_found, not schema_not_found.

Lengthlength <= 128

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/extraction-schemas/string"
{  "schema_id": "string",  "name": "string",  "description": "string",  "version": 1,  "owner": "account",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "schema": {}}