Skip to main content
PUT
/
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.update_schema(schema_id="schema_invoice_123", name="Invoice Extraction v2", metadata={
        "document_type": "invoice",
        "version": "2",
    })

    # Handle response
    print(res)
{
  "success": true,
  "data": {
    "id": "schema_invoice_123",
    "name": "Invoice Extraction v2",
    "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",
      "version": "2"
    },
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-02-01T10:30:00Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.mka1.com/llms.txt

Use this file to discover all available pages before exploring further.

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>.

Headers

​
X-On-Behalf-Of
string

Optional external end-user identifier forwarded by the API gateway.

Path Parameters

​
schema_id
string
required

The unique identifier of the extraction schema to update

Body

application/json

Fields to update in the extraction schema. All fields are optional; only provided fields will be updated.

​
name
string

Optional new name for the extraction schema

Required string length: 1 - 100
​
description
string

Optional new description for the schema

Maximum string length: 500
​
schema
object

Optional updated JSON Schema definition

​
metadata
object

Optional updated metadata

Response

200 - application/json

OK

Response from updating an existing extraction schema.

​
success
boolean
required

Indicates whether the schema update was successful

​
data
object
required

The updated extraction schema with new updatedAt timestamp