Skip to content

Developer documentation

Evidence is the API contract.

HoloSignal exposes stable REST resources, a hosted MCP surface, TypeScript-first contracts, signed webhooks and complete run receipts.

Web search API

Search, fetch, rank and cite in one call.

POST /api/v1/search?wait=10 returns ranked results from HoloSignal's own copy of each page, clean text or markdown, publication dates and licences, near-duplicate marking, and an answer that cites results by position. Filter by language, country, freshness, domains and domain class.

MCP: https://mcp.holosignal.xyz/mcp

Search API guide →
POST/api/v1/search

Search the web: ranked, fetched results with a cited answer. Add ?wait= to get the finished result with 200.

POST/api/v1/fetch

Acquire and refine one public URL as a durable run.

POST/api/v1/crawls

Start a bounded, robots-aware crawl of one site.

POST/api/v1/interactions

Run bounded read-only page interactions; submissions require Action Studio.

GET/api/v1/runs/{id}

Read a run's status, output, events, latency and signed receipt.

GET/api/v1/runs/{id}/events

Read run events as server-sent events; reconnect with Last-Event-ID until terminal.

POST/api/v1/runs/{id}/cancel

Cancel a queued or running run and release unused units.

POST/api/v1/runs/{id}/replay

Replay a completed run exactly, fresh, or as a fork.

POST/api/v1/context-packs/{id}/query

Query a Context Pack's pinned production version.

GET/api/v1/auth/whoami

Describe the presented credential, its project, environment and permissions.

POST/api/v1/usage/estimate

Estimate routes, Context Units and adviser policy before execution.

POST/api/v1/answers

Answer Studio: an agent researches and answers in a chosen mode, every claim cited; ?wait= for sync.

GET/api/v1/answers/{id}

Read an answer with its claim-to-citation map, coverage and sources; export as Markdown or HTML.

POST/api/v1/agent/run

Run a bounded research workflow with evidence and policy controls.

POST/api/v1/actions

Draft a typed GitHub, CMS, signed-webhook, or allowlisted API action.

POST/api/v1/actions/{id}/approve

Bind a one-time approval to the exact connector and immutable arguments.

POST/api/v1/actions/{id}/execute

Execute only the approved action against its bound destination.

POST/api/v1/actions/{id}/verify

Recrawl a published change and attach durable verification evidence.

GET/api/v1/marketplace/{id}/verify

Verify a marketplace package signature; Ed25519 versions can be re-verified offline against the public JWKS.

POST/api/v1/outcomes

Normalize a GA4, Search Console, or custom before/after measurement.

GET/api/health

Read current service availability.

Authentication

Dashboard access uses passwordless email sign-in. Service calls use scoped API keys, and MCP supports interactive authorization or scoped keys.

Idempotency

Send Idempotency-Key for creates and external actions. A repeated key returns the original resource, never a duplicate write.

Errors

Every error has a stable code, retryability flag, details, and documentation URL. Invalid structured output never returns success.

Runs

Search, fetch, crawl, interaction and pack queries return 202 with a run ID. Poll the run or read its events until it is completed, failed or cancelled. A search with ?wait= (up to 25 s) returns 200 with the finished result when it completes in time. An identical retry returns 200 with the original run.

Budgets

Each run reserves its budget.maxUnits before starting, commits only what it used and releases the rest. A run can never exceed its reservation.

MCP

Connect MCP clients to https://mcp.holosignal.xyz/mcp. Clients discover OAuth 2.1 from the server; scoped API keys also work as bearer credentials for server-side clients.

Rate limits

Each workspace can start 120 runs per minute; acquisition is limited to 60 requests per minute per site. A 429 response carries Retry-After in seconds.