Agent-builder quickstart

Before you read further: The agent data plane is not yet open for self-serve signup. You need an issued API key and base URL before any live request on this page will work — see Agent data plane for how access is arranged today.

Before you start

The agent data plane is not yet open for self-serve signup and has no public base URL or issued key today — see Agent data plane. You do not need either to start building: every operation’s request and response shape is already fully documented, with real example payloads, in the REST API reference.

Steps

  1. Read the operation’s documented shape.

    curl https://docs.signalsapi.com/features/agent-data-plane-api/

    Find the operation you need — for example GET /v1/companies/{company_id}/hiring-pulse — and its example response.

  2. Copy that example response into a local file, e.g. fixtures/hiring-pulse.json. The reference’s examples are the real, committed payload shape — not placeholders — so what you parse today is what a live response will look like.

  3. Build your integration against that local file instead of a live endpoint: point your HTTP client or MCP tool stub at fixtures/hiring-pulse.json and write your parsing, provenance-envelope handling, and as_of logic against it.

  4. Repeat for every operation you need, one local fixture file per operation, until the plane publishes a specification and recorded fixtures on this documentation origin — at which point the same shapes you built against move from a local file to a real URL with no reshaping required.

Check it worked

Your integration correctly reads every field in the example payload you copied — including the provenance envelope on the four history-backed reads and the shared as_of timestamp on every read — and handles the 202 {"job_id": …, "status": "crawling"} shape the plane returns for a cold company.

If it did not work

If a field in your local fixture doesn’t match what the REST API reference documents, the reference is the source of truth — re-copy the example payload. Once you have a live key, authentication errors on the plane follow the same pattern as the self-serve REST API — see My API request returns an authorization error. For anything else the reference doesn’t answer, check Is it working? or the rest of the FAQ.