URL Expired

The URL for this request expired after 30 days.

``200

object

data

object

required

Serializer for extraction schemas used in document processing.

Fields:

• id: The unique identifier of the schema
• name: DEPRECATED - Use display_name instead. The primary name of the schema.
• display_name: The primary name of the schema.
• identifier: The function name used to identify the schema.
• description: The description of the schema.
• document_matches: List of alternative names for document matching.
• is_owned: Whether the schema is owned by an organization.
• owner_organization_name: The name of the organization that owns the schema.
• labels: List of labels associated with the schema.
• sort_priority: The priority for sorting schemas.
• active: Whether the schema is enabled for your account.

id

integer

required

name

string

required

DEPRECATED: Use display_name instead

display_name

string

required

The primary name of the schema

identifier

string

required

description

string

required

Get schema description.

document_matches

array of strings

is_owned

boolean

required

Check if schema is owned by an organization.

owner_organization_name

string

required

Get the name of the owning organization.

labels

array of strings

Labels for filtering and organizing schemas (max 55 chars, letters, numbers, spaces, and dashes only)

sort_priority

integer

-2147483648 to 2147483647

Lower values appear first in lists (0 at top)

active

boolean

True if schema is enabled for your account

``400

``404

curl --request PUT \
 \
 --url https://api.flextract.dev/api/schemas/id/ \
 \
 --header 'accept: application/json' \ 
 \
 --header 'content-type: application/json'

xxxxxxxxxx

{
  "data": {
    "id": 0,
    "name": "string",
    "display_name": "string",
    "identifier": "string",
    "description": "string",
    "document_matches": [
      "string"
    ],
    "is_owned": true,
    "owner_organization_name": "string",
    "labels": [
      "string"
    ],
    "sort_priority": 0,
    "active": true
  }
}