Skip to main content
GET
/
extract
/
schemas
List Schemas
curl --request GET \
  --url https://api.contextual.ai/v1/extract/schemas \
  --header 'Authorization: Bearer <token>'
{
  "schemas": [
    {
      "schema_id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "schema_definition": {},
      "metadata": {},
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "total_count": 123,
  "next_cursor": "<string>",
  "prev_cursor": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer
default:20
cursor
string | null

Response

Successful Response

Response model for schema listing.

schemas
SchemaResponse · object[]
required

List of schemas

total_count
integer
required

Total number of schemas

next_cursor
string | null

Next cursor to continue pagination. Omitted if there are no more schemas to retrieve.

prev_cursor
string | null

Previous cursor to go back in pagination. Omitted if this is the first page.