Skip to main content
POST
Create a new API from a URL

Authorizations

X-API-Key
string
header
required

API key for programmatic access. Create one in the Parse dashboard at https://parse.bot (Settings → API Keys). Keys start with 'pmx_'.

Body

application/json
url
string
required

Website URL to generate an API from

task
string | null

Natural language description of the data you need (e.g. 'get product prices and reviews')

contributes_to_marketplace
boolean
default:true

Whether this API contributes to the shared marketplace canonical for its domain. TRUE (default) = your revisions feed back into the canonical, you can merge upstream improvements, and the build is free. FALSE = the API is fully desynced from the canonical and the build is charged. This is a permanent, per-API choice and cannot be toggled later. (The old force_new field has been removed — sending it now returns a 400.)

Response

200 - application/json

Task created or matched

task_id
string
required

Unique task identifier — use this to poll for status

matched
boolean
required

True if an existing API was found for this URL

test_inputs
array | null

Suggested test parameters for each endpoint (when matched)

may_require_auth
boolean
default:false

True if the task likely requires authentication credentials