Skip to main content

JobRequest

seriesSeriesNamerequired

A name you make up for the series. Patternode stores nothing else about it, so make it opaque: a hash of your client and asset, not their names.

Possible values: non-empty and <= 200 characters

Example: exu/7f3a9c/1b02e4/export-kw
profileProfile

The segmentation profile, optionally pinned to a version: standard or standard@2026-11. Unpinned, the version current at the call (or, with an edge, the one sealed in it) is used, and the answer names it. Versions never change and are served for at least 24 months. Your onboarding pack names the profiles for your account.

Possible values: Value must match regular expression ^[a-z][a-z0-9-]*(@[0-9]{4}-[0-9]{2})?$

Default value: standard
Examples:
Example: standard
time_unitTimeUnit

The unit of every time in the request and the answer, since the Unix epoch, UTC. In JSON, us and ns times are strings of digits; ms times are integers.

Possible values: [ms, us, ns]

Default value: ms
kindstringrequired

Possible values: [bars, samples]

formatstringrequired

Possible values: [csv, jsonl, parquet, arrow]

source_urlstring<uri>required

A presigned GET link to the file in your storage, valid for at least an hour.

Possible values: Value must match regular expression ^https://

result_urlstring<uri>required

A presigned PUT link in your storage. The result is written there as a Segmentation in JSON.

Possible values: Value must match regular expression ^https://

return_edgeboolean

Also return the series' edge, to carry on as a forming series from the end of the file.

Default value: false
webhook_urlstring<uri>

Overrides the account's webhook URL for this job.

Possible values: Value must match regular expression ^https://

JobRequest
{
  "series": "exu/7f3a9c/1b02e4/export-kw",
  "profile": "standard",
  "time_unit": "ms",
  "kind": "bars",
  "format": "csv",
  "source_url": "string",
  "result_url": "string",
  "return_edge": false,
  "webhook_url": "string"
}