COcontextualai
/extract

Update Schema

Changed on

Update an existing schema.

put/extract/schemas/{schema_id}

Request

  • Base URL
    https://api.contextual.ai/v1
  • URL
    https://api.contextual.ai/v1/extract/schemas/{schema_id}
  • Auth
    HTTP bearer

Path parameters

schema_idstring required

Request body

namestring nullable

Name of the schema

descriptionstring nullable

Description of the schema

schema_definitionobject nullable

JSON schema definition

metadataobject nullable

Additional metadata

Response

Successful Response

schema_idstring required

Unique ID of the schema

namestring required

Name of the schema

descriptionstring nullable

Description of the schema

schema_definitionobject required

JSON schema definition

metadataobject required

Schema metadata

created_atstring required

Timestamp when the schema was created

updated_atstring required

Timestamp when the schema was last updated

Changes