Skip to main content
POST
Python

Body

multipart/form-data
split_class
string
required

The split classification entries, as a JSON-encoded array of objects with name (required), description, and identifier keys. At most 19 entries. Sent as a JSON-serialized string in form data.

markdown

Markdown content to split, as an inline string or an uploaded file. Provide either markdown or markdown_url, not both.

markdown_url
string

A publicly accessible URL to the Markdown file to split. Provide either markdown or markdown_url, not both.

model
string

The split model version to use. Accepts split-latest, split, or a dated snapshot. Defaults to the latest snapshot. The resolved version is echoed back as metadata.version.

Response

The split response

The split result: the merged splits segments and request metadata.

splits
Split · object[]
required

The split segments, in page order. Consecutive pages with the same classification merge into one segment; an identifier change starts a new segment.

metadata
SplitMetadata · object
required

Information about the request: file name, page count, duration, credits, and the resolved model version.