Skip to content
Parsium Docs

Create a parser

POST
/v1/parsers

Create a validated v2 flat-config parser. description and config are required; name may come from config.name. owner_id is rejected. Idempotency keys live for 24 hours.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
Idempotency-Key
string
<= 128 characters

Deduplicates retries for 24 hours. Maximum 128 characters.

Request Body required

Section titled “Request Body required ”
object
name

Required unless config.name supplies it.

string
<= 120 characters
description
required

Required human/agent-readable purpose.

string
url

Optional documentation URL for the resource.

string format: uri
config
required

A v2 flat parser config. See the Parsers guide for HTML, JSON, API, regex, list mode, field typing, and transforms.

object
name
string
type
required
string
Allowed values: html json api regex
fields
required
Array<object>
>= 1 items <= 64 items
object
key
additional properties
any
item_selector
string
item_selector_type
string
Allowed values: css xpath
item_path
string
json_source
object
key
additional properties
any
key
additional properties
any
scrape_config

Fetch override. Credit price depends on browser and proxy settings.

object
useBrowser
boolean
waitSeconds
number
waitForBrowser
string
proxy

default, highquality, hardcore, premium, or premium:<country code>.

string
visibility
string
default: private
Allowed values: private public

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Parser created.

object
id
string
name
string
description
string
url
string
format
string
Allowed values: v2
version
integer
created_at
string format: date-time

401

Section titled “401 ”

Missing or invalid API key.

object
error
required
string
Example
invalid request
field

Field that failed validation.

string
detail
string
hint
string

422

Section titled “422 ”

Validation failed.

object
error
required
string
Example
invalid request
field

Field that failed validation.

string
detail
string
hint
string

429

Section titled “429 ”

Request, concurrency, or plan limit exceeded.

One of:
object
error
required
string
Example
invalid request
field

Field that failed validation.

string
detail
string
hint
string

Headers

Section titled “Headers ”
Retry-After
integer

Seconds to wait when supplied.