Skip to main content
POST
Run Split

Authorizations

x-api-key
string
header
required

Headers

Pulse-Version
string
default:2

Body

application/json

A request to find each topic's pages in a completed parse.

parse_id
string
required

The parse_id of a completed parse whose result hasn't expired.

Minimum string length: 1
config
SplitConfig { topics, effort } · object
required

This request's options.

async
boolean
default:false

Set to true to return 202 at once instead of waiting.

Response

The split completed. Read its pages at GET /split/{split_id}/result.

A completed split. Read its result at GET /split/{split_id}/result.

split_id
string
required

The split's id, split-<uuid>.

created_at
string
required

When the job was created.

completed_at
string
required

When the job ended.

expires_at
string

When the result will be deleted. Absent when the result is kept with no expiry.