API Reference

Create or Update a Custom API

post
https://api.diffbot.com/v3/custom

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

Body Params
notes
array of strings

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

notes
xForwardHeaders
object

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)

rules
array of objects

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

rules
string

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

string

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

string

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

string

Rendering options

prefilters
array of strings

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

prefilters
string

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

Response

Updated 6 months ago

What’s Next
Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago

What’s Next