Tool to create or update the parameters and ruleset of a Custom API. Use this when you need to define custom extraction rules for specific websites that require tailored parsing logic beyond standard Diffbot APIs. Allows defining URL patterns, CSS selectors, extraction rules, an…
apiRequiredstringThe specific API being targeted. Always precede the API name with "/api/" as in "/api/article" (except for "all")
notesarrayAn array of strings that can be added manually. The API automatically adds a note specifying when the API was last updated
rulesarrayAn array of objects that defines a set of rules for the specific urlPattern-api combination
testUrlstringA 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
useProxystringUsed to disable proxies (when they have been set globally), by applying the value "none"
prefiltersarrayAn array of CSS selector strings that should be omitted from the DOM before extraction occurs
urlPatternRequiredstringA regex pattern that defines the URLs for which the ruleset will be applied
renderOptionsstringRendering options for the page (e.g., 'mobile', 'desktop')
xForwardHeadersobjectX-Forward headers configuration.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.