Skip to main content
GET
/
api
/
v1
/
llm
/
extract
/
schema
/
{schema_id}
Python (SDK)
from mka1 import SDK


with SDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:

    res = sdk.llm.extract.get_schema(schema_id="schema_invoice_123")

    # Handle response
    print(res)
{
  "success": true,
  "data": {
    "id": "schema_invoice_123",
    "name": "Invoice Extraction",
    "description": "Schema for extracting invoice data from PDF documents",
    "schema": {
      "type": "object",
      "properties": {
        "invoice_number": {
          "type": "string"
        },
        "vendor_name": {
          "type": "string"
        },
        "total_amount": {
          "type": "number"
        },
        "date": {
          "type": "string",
          "format": "date"
        }
      },
      "required": [
        "invoice_number",
        "total_amount"
      ]
    },
    "metadata": {
      "document_type": "invoice"
    },
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:30:00Z"
  }
}

Authorizations

Authorization
string
header
required

Gateway auth: send Authorization: Bearer <mka1-api-key>. For multi-user server-side integrations, you can also send X-On-Behalf-Of: <external-user-id>.

Path Parameters

schema_id
string
required

The unique identifier of the extraction schema

Response

200 - application/json

OK

Response from retrieving an extraction schema by ID.

success
boolean
required

Indicates whether the schema retrieval was successful

data
object
required

The requested extraction schema