Create or Update a Custom API

Create or update the parameters and ruleset of an existing Custom API

byDiffbot Extract API (Web Extraction)

0calls

N/Alatency

Discover -> Inspect -> Call

Call setup

Tool IDdiffbot.custom.create.v1.44012bca

Request parametersJSON

Before this Call

1 credit / call

The final charge is settled from actual provider usage and will appear in Usage.

Field reference

apistringOptional

The specific API being targeted. Always precede the API name with "/api/" as in `"/api/article"` except for "all")

notesarrayOptional

An array of strings that can be added manually. The API automatically adds a notes specifying when the API was last updated.

rulesarrayOptional

An object that defines a set of rules for a specific urlPattern-api combination

testUrlstringOptional

A URL that can be used to check that the rule still works as intended. This is the page that will load automatically when editing the ruleset in the Dashboard UI

useProxystringOptional

Used to disable proxies (when they have been set globally), by applying the value `"none"`

prefiltersarrayOptional

An array of string selectors that should be omitted from the DOM before extraction occurs

urlPatternstringOptional

A regex that defines the URLs for which the ruleset will be applied

renderOptionsstringOptional

Rendering options

xForwardHeadersobjectOptional

Allows you to pass in X-Forward headers by name, including X-Evaluate (aka. X-Forward-X-Evaluate; omit "X-Forward" in the header name)