v1

latestOpenAPI 3.1.02026-07-26221930.5 KB

Dispatch

Create a new API from a URL

Submit a website URL to generate an API. If a matching API already exists, returns it instantly. Otherwise, queues a job to build one. Optionally describe the data you need in the task field.

post/dispatch

Request body

urlstring required

Website URL to generate an API from

taskstring nullable

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

contributes_to_marketplaceboolean

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

Task created or matched

task_idstring required

Unique task identifier — use this to poll for status

matchedboolean required

True if an existing API was found for this URL

may_require_authboolean

True if the task likely requires authentication credentials