Skip to content

Add an endpoint

If a website already has a public API but lacks the data you need, request an additional endpoint. Adding endpoints is free, subject to daily build limits. It keeps the same public API; it does not create a duplicate or grant permission to overwrite existing endpoints.

The dashboard API page guides you through the request. Coding agents can use the same workflow through the CLI or MCP.

Use the API’s handle or listing identifier from discovery:

Terminal window
agent-data parse extension target <api-reference>

Read the existing operations and the returned listingId, sourceHost and contractVersion. If canStart is false, follow the reported reason before submitting. Your requested URL must belong to the same source hostname.

Ask your coding agent to write extension.json with these fields:

FieldValue
requestIdA UUID generated once for this request.
listingIdThe target’s returned listing UUID.
contractVersionThe version returned by the target command.
urlThe relevant page on that source.
endpointsAn array of 1–20 endpoint requests.
notesAdditional context, or an empty string.

Each endpoint needs its own saved UUID id, a purpose describing the data you need, an inputs string describing accepted inputs, and an outputs string describing the returned fields. inputs, outputs and notes may be empty strings, but must be present.

Terminal window
agent-data parse extension submit extension.json --dry-run
agent-data parse extension submit extension.json
agent-data parse extension status <request-id>

The preview validates the file and masks your key without making network requests. Submission returns the saved request and build status. Keep the file: after a timeout, retry the same unchanged file. Do not regenerate request or endpoint IDs to retry.

Reusing a request ID with changed content is rejected. If the API contract changed before acceptance, inspect the target again and deliberately prepare a new request with the current version.

Wait for published before treating the endpoint as available. Then run agent-data docs <api-reference> again and call the new route using its documented inputs. If publication fails or the build is blocked, inspect status before taking the suggested next step.

The remote MCP server exposes extension_target, extension_submit and extension_status. extension_submit accepts the same saved request fields. Preserve the same identifiers and content when retrying across the CLI and MCP.