Reference

API reference

Generated from buildPlatformOpenApi(), the same document served at /platform-openapi.json. Older paths are aliases and are listed as deprecations in the changelog.

Discovery

GET/api/v1v1

Discover

Try it in the console

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

Activity

GET/api/v1/activitylist_activity

List activity

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Agents

GET/api/v1/agentslist_agents

List agents

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Alert Channels

GET/api/v1/alert-channelslist_alert_channels

List alert-channels

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Alert Rules

GET/api/v1/alert-ruleslist_alert_rules

List alert-rules

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Api Keys

GET/api/v1/api-keyslist_api_keys

List api-keys

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Batch

POST/api/v1/batch/scrapebatch

Batch scrape

Billable in credits. Credits per successful URL.

Try it in the console

Body: BatchRequest. Minimal example:

{
  "urls": []
}

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

GET/api/v1/batch/scrape/{id}batch_get

Batch status

Parameter	In	Type	Required
id	path	string	yes

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

GET/api/v1/batch/scrape/{id}/eventsbatch_events

Batch events

Parameter	In	Type	Required
id	path	string	yes
after	query	string	no
Last-Event-ID	header	string	no

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

Connector Connections

GET/api/v1/connector-connectionslist_connector_connections

List connector-connections

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Contracts

GET/api/v1/contractslist_contracts

List contracts

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Crawl

POST/api/v1/crawlcrawl

Crawl

Billable in credits. Credits per crawled page. Set limit to cap the spend.

Try it in the console

Body: CrawlRequest. Minimal example:

{
  "url": "https://example.com"
}

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

GET/api/v1/crawl/webhooks/dlqcrawl_dlq

Crawl webhook DLQ

Try it in the console

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

GET/api/v1/crawl/{id}crawl_get

Crawl status

Parameter	In	Type	Required
id	path	string	yes

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

DELETE/api/v1/crawl/{id}crawl_delete

Cancel crawl

Parameter	In	Type	Required
id	path	string	yes

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

GET/api/v1/crawl/{id}/eventscrawl_events

Crawl events

Parameter	In	Type	Required
id	path	string	yes
after	query	string	no
Last-Event-ID	header	string	no

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

POST/api/v1/crawl/{id}/pausecrawl_pause

Pause crawl

Parameter	In	Type	Required
id	path	string	yes

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

POST/api/v1/crawl/{id}/resumecrawl_resume

Resume crawl

Parameter	In	Type	Required
id	path	string	yes

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

Credits

GET/api/v1/creditscredits

Credits

Try it in the console

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

Dashboards

GET/api/v1/dashboardslist_dashboards

List dashboards

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Datasets

GET/api/v1/datasetslist_datasets

List datasets

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Enrichments

GET/api/v1/enrichmentslist_enrichments

List enrichments

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Entities

GET/api/v1/entitieslist_entities

List entities

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Events

GET/api/v1/eventslist_events

List events

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Extract

POST/api/v1/extractextract

Extract

Billable in credits. Credits per URL extracted.

Try it in the console

Body: ExtractRequest. Minimal example:

{}

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

GET/api/v1/extract/modelsextract_models

Extract models

Try it in the console

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

POST/api/v1/extract/siteextract_site

Site extract

Try it in the console

Body: ExtractRequest. Minimal example:

{}

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

Jobs

GET/api/v1/jobslist_jobs

List jobs

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Llms

POST/api/v1/llmsllms

llms.txt

Billable in credits. Credits per page in the llms.txt.

Try it in the console

Body: LlmsRequest. Minimal example:

{
  "url": "https://example.com"
}

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

GET/api/v1/llms/{id}llms_get

llms.txt status

Parameter	In	Type	Required
id	path	string	yes

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

GET/api/v1/llms/{id}/downloadllms_download

llms.txt download

Parameter	In	Type	Required
id	path	string	yes

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

Map

POST/api/v1/mapmap

Map

Billable in credits. Credits per map.

Try it in the console

Body: MapRequest. Minimal example:

{
  "url": "https://example.com"
}

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

Mappings

GET/api/v1/mappingslist_mappings

List mappings

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Openapi JSON

GET/api/v1/openapi.jsonopenapi

OpenAPI

Try it in the console

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

Packs

GET/api/v1/packslist_packs

List packs

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Platform Openapi JSON

GET/api/v1/platform-openapi.json

Read the versioned platform OpenAPI document

Try it in the console

Queries

POST/api/v1/queriesrun_query

Run a SQL, structured, saved, or metric query

Metered against the query quota. Metered against your plan’s monthly bytes-scanned and compute quota. The response reports bytes scanned and credits used.

Try it in the console

Body: QueryRequest. Minimal example:

{}

Rate-limit headers on every response. Error statuses: 400, 429.

Retrievals

POST/api/v1/retrievalsretrieve

Retrieve ranked text chunks from a lake table

Try it in the console

Body: RetrievalRequest. Minimal example:

{
  "table": "table",
  "query": "query"
}

Rate-limit headers on every response. Error statuses: 400, 429.

Scrape

POST/api/v1/scrapescrape

Scrape

Billable in credits. Credits per fresh scrape, plus add-ons. A maxAge cache hit costs less.

Try it in the console

Body: ScrapeRequest. Minimal example:

{
  "url": "https://example.com"
}

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

GET/api/v1/scrape/credentialsscrape_credentials_get

List scrape credentials

Try it in the console

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

POST/api/v1/scrape/credentialsscrape_credentials_post

Store scrape credentials

Try it in the console

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

GET/api/v1/scrape/pdfsscrape_pdfs

Fetch PDF

Try it in the console

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

GET/api/v1/scrape/screenshotsscrape_screenshots

Fetch screenshot

Try it in the console

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

Search

POST/api/v1/searchsearch

Billable in credits. Credits per result, plus per scraped result when scrape is true.

Try it in the console

Body: SearchRequest. Minimal example:

{
  "query": "query"
}

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

GET/api/v1/search/credentialssearch_credentials_get

Describe search credentials

Try it in the console

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

POST/api/v1/search/credentialssearch_credentials_post

Store search credentials

Try it in the console

Body: ScrapeRequest. Minimal example:

{
  "url": "https://example.com"
}

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

Targets

GET/api/v1/targetslist_targets

List targets

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Templates

GET/api/v1/templateslist_templates

List templates

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Usage

GET/api/v1/usageget_api_usage

API usage by endpoint: calls, error rate, latency, and credits

Try it in the console

Parameter	In	Type	Required
from	query	string	no
to	query	string	no
format	query	"json" \| "csv"	no

Rate-limit headers on every response. Error statuses: 400, 429.

Users

GET/api/v1/userslist_users

List users

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Webhooks

GET/api/v1/webhookslist_webhooks

List webhooks

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Workflows

GET/api/v1/workflowslist_workflows

List workflows

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Reference

API reference

Generated from buildPlatformOpenApi(), the same document served at /platform-openapi.json. Older paths are aliases and are listed as deprecations in the changelog.

Discovery

GET/api/v1v1

Discover

Try it in the console

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

Activity

GET/api/v1/activitylist_activity

List activity

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Agents

GET/api/v1/agentslist_agents

List agents

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Alert Channels

GET/api/v1/alert-channelslist_alert_channels

List alert-channels

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Alert Rules

GET/api/v1/alert-ruleslist_alert_rules

List alert-rules

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Api Keys

GET/api/v1/api-keyslist_api_keys

List api-keys

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Batch

POST/api/v1/batch/scrapebatch

Batch scrape

Billable in credits. Credits per successful URL.

Try it in the console

Body: BatchRequest. Minimal example:

{
  "urls": []
}

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

GET/api/v1/batch/scrape/{id}batch_get

Batch status

Parameter	In	Type	Required
id	path	string	yes

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

GET/api/v1/batch/scrape/{id}/eventsbatch_events

Batch events

Parameter	In	Type	Required
id	path	string	yes
after	query	string	no
Last-Event-ID	header	string	no

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

Connector Connections

GET/api/v1/connector-connectionslist_connector_connections

List connector-connections

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Contracts

GET/api/v1/contractslist_contracts

List contracts

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Crawl

POST/api/v1/crawlcrawl

Crawl

Billable in credits. Credits per crawled page. Set limit to cap the spend.

Try it in the console

Body: CrawlRequest. Minimal example:

{
  "url": "https://example.com"
}

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

GET/api/v1/crawl/webhooks/dlqcrawl_dlq

Crawl webhook DLQ

Try it in the console

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

GET/api/v1/crawl/{id}crawl_get

Crawl status

Parameter	In	Type	Required
id	path	string	yes

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

DELETE/api/v1/crawl/{id}crawl_delete

Cancel crawl

Parameter	In	Type	Required
id	path	string	yes

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

GET/api/v1/crawl/{id}/eventscrawl_events

Crawl events

Parameter	In	Type	Required
id	path	string	yes
after	query	string	no
Last-Event-ID	header	string	no

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

POST/api/v1/crawl/{id}/pausecrawl_pause

Pause crawl

Parameter	In	Type	Required
id	path	string	yes

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

POST/api/v1/crawl/{id}/resumecrawl_resume

Resume crawl

Parameter	In	Type	Required
id	path	string	yes

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

Credits

GET/api/v1/creditscredits

Credits

Try it in the console

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

Dashboards

GET/api/v1/dashboardslist_dashboards

List dashboards

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Datasets

GET/api/v1/datasetslist_datasets

List datasets

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Enrichments

GET/api/v1/enrichmentslist_enrichments

List enrichments

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Entities

GET/api/v1/entitieslist_entities

List entities

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Events

GET/api/v1/eventslist_events

List events

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Extract

POST/api/v1/extractextract

Extract

Billable in credits. Credits per URL extracted.

Try it in the console

Body: ExtractRequest. Minimal example:

{}

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

GET/api/v1/extract/modelsextract_models

Extract models

Try it in the console

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

POST/api/v1/extract/siteextract_site

Site extract

Try it in the console

Body: ExtractRequest. Minimal example:

{}

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

Jobs

GET/api/v1/jobslist_jobs

List jobs

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Llms

POST/api/v1/llmsllms

llms.txt

Billable in credits. Credits per page in the llms.txt.

Try it in the console

Body: LlmsRequest. Minimal example:

{
  "url": "https://example.com"
}

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

GET/api/v1/llms/{id}llms_get

llms.txt status

Parameter	In	Type	Required
id	path	string	yes

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

GET/api/v1/llms/{id}/downloadllms_download

llms.txt download

Parameter	In	Type	Required
id	path	string	yes

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

Map

POST/api/v1/mapmap

Map

Billable in credits. Credits per map.

Try it in the console

Body: MapRequest. Minimal example:

{
  "url": "https://example.com"
}

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

Mappings

GET/api/v1/mappingslist_mappings

List mappings

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Openapi JSON

GET/api/v1/openapi.jsonopenapi

OpenAPI

Try it in the console

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

Packs

GET/api/v1/packslist_packs

List packs

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Platform Openapi JSON

GET/api/v1/platform-openapi.json

Read the versioned platform OpenAPI document

Try it in the console

Queries

POST/api/v1/queriesrun_query

Run a SQL, structured, saved, or metric query

Metered against the query quota. Metered against your plan’s monthly bytes-scanned and compute quota. The response reports bytes scanned and credits used.

Try it in the console

Body: QueryRequest. Minimal example:

{}

Rate-limit headers on every response. Error statuses: 400, 429.

Retrievals

POST/api/v1/retrievalsretrieve

Retrieve ranked text chunks from a lake table

Try it in the console

Body: RetrievalRequest. Minimal example:

{
  "table": "table",
  "query": "query"
}

Rate-limit headers on every response. Error statuses: 400, 429.

Scrape

POST/api/v1/scrapescrape

Scrape

Billable in credits. Credits per fresh scrape, plus add-ons. A maxAge cache hit costs less.

Try it in the console

Body: ScrapeRequest. Minimal example:

{
  "url": "https://example.com"
}

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

GET/api/v1/scrape/credentialsscrape_credentials_get

List scrape credentials

Try it in the console

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

POST/api/v1/scrape/credentialsscrape_credentials_post

Store scrape credentials

Try it in the console

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

GET/api/v1/scrape/pdfsscrape_pdfs

Fetch PDF

Try it in the console

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

GET/api/v1/scrape/screenshotsscrape_screenshots

Fetch screenshot

Try it in the console

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

Search

POST/api/v1/searchsearch

Billable in credits. Credits per result, plus per scraped result when scrape is true.

Try it in the console

Body: SearchRequest. Minimal example:

{
  "query": "query"
}

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

GET/api/v1/search/credentialssearch_credentials_get

Describe search credentials

Try it in the console

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

POST/api/v1/search/credentialssearch_credentials_post

Store search credentials

Try it in the console

Body: ScrapeRequest. Minimal example:

{
  "url": "https://example.com"
}

Error statuses: 400, 402, 403, 404, 422, 429, 502, 504.

Targets

GET/api/v1/targetslist_targets

List targets

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Templates

GET/api/v1/templateslist_templates

List templates

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Usage

GET/api/v1/usageget_api_usage

API usage by endpoint: calls, error rate, latency, and credits

Try it in the console

Parameter	In	Type	Required
from	query	string	no
to	query	string	no
format	query	"json" \| "csv"	no

Rate-limit headers on every response. Error statuses: 400, 429.

Users

GET/api/v1/userslist_users

List users

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Webhooks

GET/api/v1/webhookslist_webhooks

List webhooks

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.

Workflows

GET/api/v1/workflowslist_workflows

List workflows

Try it in the console

Parameter	In	Type	Required
cursor	query	string	no
limit	query	integer	no
filter	query	string	no
sort	query	string	no
page	query	integer	no

Rate-limit headers on every response. Error statuses: 400, 429.