Skip to main content
PUT
/
extract
/
schemas
/
{schema_id}
Update Schema
curl --request PUT \
  --url https://api.contextual.ai/v1/extract/schemas/{schema_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "schema_definition": {},
  "metadata": {}
}'
{
  "schema_id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "schema_definition": {},
  "metadata": {},
  "created_at": "<string>",
  "updated_at": "<string>"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

schema_id
string
required

Body

application/json

Request model for updating a schema.

name
string | null

Name of the schema

description
string | null

Description of the schema

schema_definition
object | null

JSON schema definition

metadata
object | null

Additional metadata

Response

Successful Response

Response model for schema information.

schema_id
string
required

Unique ID of the schema

name
string
required

Name of the schema

schema_definition
object
required

JSON schema definition

metadata
object
required

Schema metadata

created_at
string
required

Timestamp when the schema was created

updated_at
string
required

Timestamp when the schema was last updated

description
string | null

Description of the schema