Dispatch

Create a new API from a URL

Changed on

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

  • Base URL
    https://api.parse.bot
  • URL
    https://api.parse.bot/dispatch
  • Auth
    API key in header X-API-Key

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.)

allow_authboolean

Permit this build to proceed when the site requires a login. Programmatic (API key / MCP) callers must opt in: an authenticated build pauses at status=needs_input waiting for credentials, consumes a per-domain auth session, and runs as a private build. Requires a paid plan and a one-time disclaimer acceptance in the Parse dashboard. Setting this does NOT assert the site needs auth — that verdict stays server-side.

workspaceboolean

Build this API directly into the caller's team workspace instead of their personal space, so every teammate can see and revise it. Requires a workspace on a Team plan; otherwise the dispatch is rejected with 402 rather than silently landing as personal.

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

Changes

    • info

      added the new optional request property

    • info

      added the new optional request property