API changelog and deprecation policy

Generated from apiChangelog(). Regenerate this page from that record. Do not type the entries by hand.

Policy

require a new URI version (/api/v2, …). Additive response fields on v1 are non-breaking.

Deprecation window: 180 days
Sunset: 2027-02-19T00:00:00.000Z
A deprecated response sets the deprecation warning header to true and the sunset header to the HTTP date.
The link header names the successor with rel="successor-version".

Changelog

api-key-scopes (addition, 2026-11-10): API keys can be scoped by resource, action, dataset, and environment.
api-usage-analytics (addition, 2026-11-10): GET /api/v1/usage reports API-key calls by endpoint for the caller’s workspace: calls, client and server error rates, average and bucketed p50/p95 latency, and credits, per billing month. format=csv exports the same report.
cursor-pagination (change, 2026-11-10): List reads default to cursor pagination with filter and sort.
deprecate-activity-api-activity (deprecation, 2026-11-10): /api/activity is deprecated. Use /api/v1/activity. Successor /api/v1/activity. Sunset 2027-02-19T00:00:00.000Z.
deprecate-agents-api-agents (deprecation, 2026-11-10): /api/agents is deprecated. Use /api/v1/agents. Successor /api/v1/agents. Sunset 2027-02-19T00:00:00.000Z.
deprecate-alert-channels-api-alert-channels (deprecation, 2026-11-10): /api/alert-channels is deprecated. Use /api/v1/alert-channels. Successor /api/v1/alert-channels. Sunset 2027-02-19T00:00:00.000Z.
deprecate-alert-rules-api-alert-rules (deprecation, 2026-11-10): /api/alert-rules is deprecated. Use /api/v1/alert-rules. Successor /api/v1/alert-rules. Sunset 2027-02-19T00:00:00.000Z.
deprecate-api-keys-api-api-keys (deprecation, 2026-11-10): /api/api-keys is deprecated. Use /api/v1/api-keys. Successor /api/v1/api-keys. Sunset 2027-02-19T00:00:00.000Z.
deprecate-connector-connections-api-connectors-connections (deprecation, 2026-11-10): /api/connectors/connections is deprecated. Use /api/v1/connector-connections. Successor /api/v1/connector-connections. Sunset 2027-02-19T00:00:00.000Z.
deprecate-contracts-api-contracts (deprecation, 2026-11-10): /api/contracts is deprecated. Use /api/v1/contracts. Successor /api/v1/contracts. Sunset 2027-02-19T00:00:00.000Z.
deprecate-crawl-api-crawl (deprecation, 2026-11-10): /api/crawl is deprecated. Use /api/v1/crawl. Successor /api/v1/crawl. Sunset 2027-02-19T00:00:00.000Z.
deprecate-dashboards-api-dashboards (deprecation, 2026-11-10): /api/dashboards is deprecated. Use /api/v1/dashboards. Successor /api/v1/dashboards. Sunset 2027-02-19T00:00:00.000Z.
deprecate-datasets-api-data (deprecation, 2026-11-10): /api/data is deprecated. Use /api/v1/datasets. Successor /api/v1/datasets. Sunset 2027-02-19T00:00:00.000Z.
deprecate-enrichments-api-enrich (deprecation, 2026-11-10): /api/enrich is deprecated. Use /api/v1/enrichments. Successor /api/v1/enrichments. Sunset 2027-02-19T00:00:00.000Z.
deprecate-entities-api-entities (deprecation, 2026-11-10): /api/entities is deprecated. Use /api/v1/entities. Successor /api/v1/entities. Sunset 2027-02-19T00:00:00.000Z.
deprecate-events-api-events (deprecation, 2026-11-10): /api/events is deprecated. Use /api/v1/events. Successor /api/v1/events. Sunset 2027-02-19T00:00:00.000Z.
deprecate-jobs-api-jobs (deprecation, 2026-11-10): /api/jobs is deprecated. Use /api/v1/jobs. Successor /api/v1/jobs. Sunset 2027-02-19T00:00:00.000Z.
deprecate-map-api-crawl-map (deprecation, 2026-11-10): /api/crawl/map is deprecated. Use /api/v1/map. Successor /api/v1/map. Sunset 2027-02-19T00:00:00.000Z.
deprecate-mappings-api-mappings (deprecation, 2026-11-10): /api/mappings is deprecated. Use /api/v1/mappings. Successor /api/v1/mappings. Sunset 2027-02-19T00:00:00.000Z.
deprecate-packs-api-packs (deprecation, 2026-11-10): /api/packs is deprecated. Use /api/v1/packs. Successor /api/v1/packs. Sunset 2027-02-19T00:00:00.000Z.
deprecate-queries-api-query (deprecation, 2026-11-10): /api/query is deprecated. Use /api/v1/queries. Successor /api/v1/queries. Sunset 2027-02-19T00:00:00.000Z.
deprecate-retrievals-api-retrieve (deprecation, 2026-11-10): /api/retrieve is deprecated. Use /api/v1/retrievals. Successor /api/v1/retrievals. Sunset 2027-02-19T00:00:00.000Z.
deprecate-scrape-api-crawl-scrape (deprecation, 2026-11-10): /api/crawl/scrape is deprecated. Use /api/v1/scrape. Successor /api/v1/scrape. Sunset 2027-02-19T00:00:00.000Z.
deprecate-targets-api-targets (deprecation, 2026-11-10): /api/targets is deprecated. Use /api/v1/targets. Successor /api/v1/targets. Sunset 2027-02-19T00:00:00.000Z.
deprecate-templates-api-templates (deprecation, 2026-11-10): /api/templates is deprecated. Use /api/v1/templates. Successor /api/v1/templates. Sunset 2027-02-19T00:00:00.000Z.
deprecate-users-api-users (deprecation, 2026-11-10): /api/users is deprecated. Use /api/v1/users. Successor /api/v1/users. Sunset 2027-02-19T00:00:00.000Z.
deprecate-webhooks-api-webhooks (deprecation, 2026-11-10): /api/webhooks is deprecated. Use /api/v1/webhooks. Successor /api/v1/webhooks. Sunset 2027-02-19T00:00:00.000Z.
deprecate-workflows-api-workflows (deprecation, 2026-11-10): /api/workflows is deprecated. Use /api/v1/workflows. Successor /api/v1/workflows. Sunset 2027-02-19T00:00:00.000Z.
error-contract (addition, 2026-11-10): Errors return a stable code, message, remediation, and request id.
rate-limit-headers (addition, 2026-11-10): Responses include limit, remaining, and reset headers.
spec-post-queries-retrievals (change, 2026-11-10): The OpenAPI spec lists POST, with QueryRequest and RetrievalRequest bodies, for queries and retrievals. These routes never served GET; the generated listQueries and listRetrievals methods are now runQuery and retrieve.
v1-surface (addition, 2026-11-10): Customer resources are canonical under /api/v1. Older paths stay as aliases.

API changelog and deprecation policy

Generated from apiChangelog(). Regenerate this page from that record. Do not type the entries by hand.

Policy

require a new URI version (/api/v2, …). Additive response fields on v1 are non-breaking.

Deprecation window: 180 days

Sunset: 2027-02-19T00:00:00.000Z

A deprecated response sets the deprecation warning header to true and the sunset header to the HTTP date.

The link header names the successor with rel="successor-version".

Changelog

api-key-scopes (addition, 2026-11-10): API keys can be scoped by resource, action, dataset, and environment.

api-usage-analytics (addition, 2026-11-10): GET /api/v1/usage reports API-key calls by endpoint for the caller’s workspace: calls, client and server error rates, average and bucketed p50/p95 latency, and credits, per billing month. format=csv exports the same report.

cursor-pagination (change, 2026-11-10): List reads default to cursor pagination with filter and sort.

deprecate-activity-api-activity (deprecation, 2026-11-10): /api/activity is deprecated. Use /api/v1/activity. Successor /api/v1/activity. Sunset 2027-02-19T00:00:00.000Z.

deprecate-agents-api-agents (deprecation, 2026-11-10): /api/agents is deprecated. Use /api/v1/agents. Successor /api/v1/agents. Sunset 2027-02-19T00:00:00.000Z.

deprecate-alert-channels-api-alert-channels (deprecation, 2026-11-10): /api/alert-channels is deprecated. Use /api/v1/alert-channels. Successor /api/v1/alert-channels. Sunset 2027-02-19T00:00:00.000Z.

deprecate-alert-rules-api-alert-rules (deprecation, 2026-11-10): /api/alert-rules is deprecated. Use /api/v1/alert-rules. Successor /api/v1/alert-rules. Sunset 2027-02-19T00:00:00.000Z.

deprecate-api-keys-api-api-keys (deprecation, 2026-11-10): /api/api-keys is deprecated. Use /api/v1/api-keys. Successor /api/v1/api-keys. Sunset 2027-02-19T00:00:00.000Z.

deprecate-connector-connections-api-connectors-connections (deprecation, 2026-11-10): /api/connectors/connections is deprecated. Use /api/v1/connector-connections. Successor /api/v1/connector-connections. Sunset 2027-02-19T00:00:00.000Z.

deprecate-contracts-api-contracts (deprecation, 2026-11-10): /api/contracts is deprecated. Use /api/v1/contracts. Successor /api/v1/contracts. Sunset 2027-02-19T00:00:00.000Z.

deprecate-crawl-api-crawl (deprecation, 2026-11-10): /api/crawl is deprecated. Use /api/v1/crawl. Successor /api/v1/crawl. Sunset 2027-02-19T00:00:00.000Z.

deprecate-dashboards-api-dashboards (deprecation, 2026-11-10): /api/dashboards is deprecated. Use /api/v1/dashboards. Successor /api/v1/dashboards. Sunset 2027-02-19T00:00:00.000Z.

deprecate-datasets-api-data (deprecation, 2026-11-10): /api/data is deprecated. Use /api/v1/datasets. Successor /api/v1/datasets. Sunset 2027-02-19T00:00:00.000Z.

deprecate-enrichments-api-enrich (deprecation, 2026-11-10): /api/enrich is deprecated. Use /api/v1/enrichments. Successor /api/v1/enrichments. Sunset 2027-02-19T00:00:00.000Z.

deprecate-entities-api-entities (deprecation, 2026-11-10): /api/entities is deprecated. Use /api/v1/entities. Successor /api/v1/entities. Sunset 2027-02-19T00:00:00.000Z.

deprecate-events-api-events (deprecation, 2026-11-10): /api/events is deprecated. Use /api/v1/events. Successor /api/v1/events. Sunset 2027-02-19T00:00:00.000Z.

deprecate-jobs-api-jobs (deprecation, 2026-11-10): /api/jobs is deprecated. Use /api/v1/jobs. Successor /api/v1/jobs. Sunset 2027-02-19T00:00:00.000Z.

deprecate-map-api-crawl-map (deprecation, 2026-11-10): /api/crawl/map is deprecated. Use /api/v1/map. Successor /api/v1/map. Sunset 2027-02-19T00:00:00.000Z.

deprecate-mappings-api-mappings (deprecation, 2026-11-10): /api/mappings is deprecated. Use /api/v1/mappings. Successor /api/v1/mappings. Sunset 2027-02-19T00:00:00.000Z.

deprecate-packs-api-packs (deprecation, 2026-11-10): /api/packs is deprecated. Use /api/v1/packs. Successor /api/v1/packs. Sunset 2027-02-19T00:00:00.000Z.

deprecate-queries-api-query (deprecation, 2026-11-10): /api/query is deprecated. Use /api/v1/queries. Successor /api/v1/queries. Sunset 2027-02-19T00:00:00.000Z.

deprecate-retrievals-api-retrieve (deprecation, 2026-11-10): /api/retrieve is deprecated. Use /api/v1/retrievals. Successor /api/v1/retrievals. Sunset 2027-02-19T00:00:00.000Z.

deprecate-scrape-api-crawl-scrape (deprecation, 2026-11-10): /api/crawl/scrape is deprecated. Use /api/v1/scrape. Successor /api/v1/scrape. Sunset 2027-02-19T00:00:00.000Z.

deprecate-targets-api-targets (deprecation, 2026-11-10): /api/targets is deprecated. Use /api/v1/targets. Successor /api/v1/targets. Sunset 2027-02-19T00:00:00.000Z.

deprecate-templates-api-templates (deprecation, 2026-11-10): /api/templates is deprecated. Use /api/v1/templates. Successor /api/v1/templates. Sunset 2027-02-19T00:00:00.000Z.

deprecate-users-api-users (deprecation, 2026-11-10): /api/users is deprecated. Use /api/v1/users. Successor /api/v1/users. Sunset 2027-02-19T00:00:00.000Z.

deprecate-webhooks-api-webhooks (deprecation, 2026-11-10): /api/webhooks is deprecated. Use /api/v1/webhooks. Successor /api/v1/webhooks. Sunset 2027-02-19T00:00:00.000Z.

deprecate-workflows-api-workflows (deprecation, 2026-11-10): /api/workflows is deprecated. Use /api/v1/workflows. Successor /api/v1/workflows. Sunset 2027-02-19T00:00:00.000Z.

error-contract (addition, 2026-11-10): Errors return a stable code, message, remediation, and request id.

rate-limit-headers (addition, 2026-11-10): Responses include limit, remaining, and reset headers.

spec-post-queries-retrievals (change, 2026-11-10): The OpenAPI spec lists POST, with QueryRequest and RetrievalRequest bodies, for queries and retrievals. These routes never served GET; the generated listQueries and listRetrievals methods are now runQuery and retrieve.

v1-surface (addition, 2026-11-10): Customer resources are canonical under /api/v1. Older paths stay as aliases.