Browse the reference

Developers

API reference

Every endpoint a workspace API key can call, the webhook events ASDK sends and the objects they carry. Generated from the API contract, so it always matches the API.

Base URL: https://api.asdk.com
Version: 0.1.0 · OpenAPI 3.1.0 · OpenAPI description (JSON)

Overview

Coming soon API access

The public API and the MCP server are coming soon. Server-side answers, knowledge search and the MCP server are part of API access, included from the Business plan and during the trial. Webhooks are in early access and included from the Starter plan. Reads with an API key work on every plan.

Send a workspace API key as a bearer token. Create keys in the dashboard under Settings → API; a key acts on its own workspace only. Keys with the read scope call the read endpoints; keys with the write scope also call the endpoints marked “Write scope”. Errors are RFC 9457 problem details with a stable type, such as insufficient-scope or rate-limited (retry after the Retry-After header).

Shell

curl https://api.asdk.com/v1/workspaces/$WORKSPACE_ID/sites \
  -H "Authorization: Bearer $ASDK_API_KEY"

Guides: authentication and scopes, webhooks, MCP server, rate limits.

Workspaces

Workspaces and their settings.

Get a workspace

GET/v1/workspaces/{id}· Read

Any member, or an API key of this workspace.

Parameters

Get a workspace: Parameters
Field	Type	Description
`id`path · required	string (≤ 64 chars)	Workspace id (wsp_…).

Responses

200The workspace. (Workspace)
401Missing, expired or revoked credentials (types "unauthorized", "token-expired", "invalid-token").
404Not found, or not visible to the caller (type "not-found").
defaultAn error, as RFC 9457 problem details.

Shell

curl https://api.asdk.com/v1/workspaces/{id} \
  -H "Authorization: Bearer $ASDK_API_KEY"

Whether ASDK suspended the workspace

GET/v1/workspaces/{id}/suspension· Read

Any member (and the workspace's API keys). A suspended workspace's widgets are unavailable and its dashboard is read-only: writes answer 403 (response WorkspaceSuspended). The dashboard shows a banner from this.

Parameters

Whether ASDK suspended the workspace: Parameters
Field	Type	Description
`id`path · required	string (≤ 64 chars)	Workspace id (wsp_…).

Responses

200The workspace's suspension. (WorkspaceSuspension)
401Missing, expired or revoked credentials (types "unauthorized", "token-expired", "invalid-token").
404Not found, or not visible to the caller (type "not-found").
defaultAn error, as RFC 9457 problem details.

Shell

curl https://api.asdk.com/v1/workspaces/{id}/suspension \
  -H "Authorization: Bearer $ASDK_API_KEY"

Sites

The websites a workspace's agents work on.

List the workspace's sites

GET/v1/workspaces/{id}/sites· Read

Every site with a summary of its knowledge, and the plan's site and page limits.

Parameters

List the workspace's sites: Parameters
Field	Type	Description
`id`path · required	string (≤ 64 chars)	Workspace id (wsp_…).

Responses

200Sites, oldest first. (SiteList)
401Missing, expired or revoked credentials (types "unauthorized", "token-expired", "invalid-token").
404Not found, or not visible to the caller (type "not-found").
defaultAn error, as RFC 9457 problem details.

Shell

curl https://api.asdk.com/v1/workspaces/{id}/sites \
  -H "Authorization: Bearer $ASDK_API_KEY"

A site

GET/v1/sites/{siteId}· Read

Parameters

A site: Parameters
Field	Type	Description
`siteId`path · required	string (≤ 64 chars)	Site id (site_…).

Responses

200The site. (Site)
401Missing, expired or revoked credentials (types "unauthorized", "token-expired", "invalid-token").
404Not found, or not visible to the caller (type "not-found").
defaultAn error, as RFC 9457 problem details.

Shell

curl https://api.asdk.com/v1/sites/{siteId} \
  -H "Authorization: Bearer $ASDK_API_KEY"

Knowledge

Knowledge sources, their documents and Q&A pairs.

List a site's knowledge sources

GET/v1/sites/{siteId}/sources· Read

Sources, oldest first, including the site's Q&A source once it has pairs. Text snippet bodies are left out; read one source for its body.

Parameters

List a site's knowledge sources: Parameters
Field	Type	Description
`siteId`path · required	string (≤ 64 chars)	Site id (site_…).

Responses

200The sources. (SourceList)
401Missing, expired or revoked credentials (types "unauthorized", "token-expired", "invalid-token").
404Not found, or not visible to the caller (type "not-found").
defaultAn error, as RFC 9457 problem details.

Shell

curl https://api.asdk.com/v1/sites/{siteId}/sources \
  -H "Authorization: Bearer $ASDK_API_KEY"

A knowledge source

GET/v1/sources/{sourceId}· Read

Status and progress of the last or running sync; poll every few seconds while syncing.

Parameters

A knowledge source: Parameters
Field	Type	Description
`sourceId`path · required	string (≤ 64 chars)	Knowledge source id (src_…).

Responses

200The source. (Source)
401Missing, expired or revoked credentials (types "unauthorized", "token-expired", "invalid-token").
404Not found, or not visible to the caller (type "not-found").
defaultAn error, as RFC 9457 problem details.

Shell

curl https://api.asdk.com/v1/sources/{sourceId} \
  -H "Authorization: Bearer $ASDK_API_KEY"

Sync a source now

POST/v1/sources/{sourceId}/sync· Write scope

Reads the source again; unchanged pages are not embedded again. A request during a sync runs another sync after it.

Parameters

Sync a source now: Parameters
Field	Type	Description
`sourceId`path · required	string (≤ 64 chars)	Knowledge source id (src_…).

Responses

202The sync is queued. (Source)
401Missing, expired or revoked credentials (types "unauthorized", "token-expired", "invalid-token").
403Authenticated but not allowed (types "forbidden", "origin-not-allowed", "api-key-not-accepted", "email-mismatch"; P36 "insufficient-scope", "not-in-plan", "coming-soon").
404Not found, or not visible to the caller (type "not-found").
409Conflicts with the plan or the resource (types "limit-reached", "site-exists", "not-supported").
defaultAn error, as RFC 9457 problem details.

Shell

curl -X POST https://api.asdk.com/v1/sources/{sourceId}/sync \
  -H "Authorization: Bearer $ASDK_API_KEY"

List a source's documents

GET/v1/sources/{sourceId}/documents· Read

Ordered by URL, a page at a time; q searches URL and title.

Parameters

List a source's documents: Parameters
Field	Type	Description
`sourceId`path · required	string (≤ 64 chars)	Knowledge source id (src_…).
`q`query · optional	string (≤ 200 chars)	Case-insensitive text search.
`cursor`query · optional	string (≤ 4,096 chars)	The `nextCursor` of the previous page.
`limit`query · optional	integer (1–200)	Items per page (default 50).
`status`query · optional	"pending" \| "indexed" \| "skipped" \| "excluded" \| "error"

Responses

200A page of documents. (DocumentList)
400Invalid input (type "validation"; field names the input).
401Missing, expired or revoked credentials (types "unauthorized", "token-expired", "invalid-token").
404Not found, or not visible to the caller (type "not-found").
defaultAn error, as RFC 9457 problem details.

Shell

curl https://api.asdk.com/v1/sources/{sourceId}/documents \
  -H "Authorization: Bearer $ASDK_API_KEY"

List a site's Q&A pairs

GET/v1/sites/{siteId}/qa· Read

Newest first, a page at a time; q searches questions and answers.

Parameters

List a site's Q&A pairs: Parameters
Field	Type	Description
`siteId`path · required	string (≤ 64 chars)	Site id (site_…).
`q`query · optional	string (≤ 200 chars)	Case-insensitive text search.
`cursor`query · optional	string (≤ 4,096 chars)	The `nextCursor` of the previous page.
`limit`query · optional	integer (1–200)	Items per page (default 50).

Responses

200A page of Q&A pairs. (QaPairList)
400Invalid input (type "validation"; field names the input).
401Missing, expired or revoked credentials (types "unauthorized", "token-expired", "invalid-token").
404Not found, or not visible to the caller (type "not-found").
defaultAn error, as RFC 9457 problem details.

Shell

curl https://api.asdk.com/v1/sites/{siteId}/qa \
  -H "Authorization: Bearer $ASDK_API_KEY"

Add a Q&A pair

POST/v1/sites/{siteId}/qa· Write scope

Each pair is embedded as its own vector (kind qa), which the answer engine prefers on ties.

Parameters

Add a Q&A pair: Parameters
Field	Type	Description
`siteId`path · required	string (≤ 64 chars)	Site id (site_…).

Request body (QaPairInput)

Add a Q&A pair: Request body
Field	Type	Description
`question`required	string (≤ 1,000 chars)
`answer`required	string (≤ 8,000 chars)

Responses

201The new pair, being embedded. (QaPair)
400Invalid input (type "validation"; field names the input).
401Missing, expired or revoked credentials (types "unauthorized", "token-expired", "invalid-token").
403Authenticated but not allowed (types "forbidden", "origin-not-allowed", "api-key-not-accepted", "email-mismatch"; P36 "insufficient-scope", "not-in-plan", "coming-soon").
404Not found, or not visible to the caller (type "not-found").
409Conflicts with the plan or the resource (types "limit-reached", "site-exists", "not-supported").
defaultAn error, as RFC 9457 problem details.

Shell

curl -X POST https://api.asdk.com/v1/sites/{siteId}/qa \
  -H "Authorization: Bearer $ASDK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"question":"…","answer":"…"}'

Answers

Server-side answers from a site's knowledge (API keys with the write scope).

Answer a question from a site's knowledge

POST/v1/sites/{siteId}/ask· Write scope

Answers a question server-side exactly as the site's chat widget would: the same knowledge base, the same grounding and citations. grounded is false when the knowledge base did not cover the question (the question is then recorded as a knowledge gap).

Needs a person (any member) or an API key with the write scope, and API access in the workspace's plan ("not-in-plan" otherwise). While the catalog lists API access as coming soon, every workspace gets 403 "coming-soon". Every answer counts toward the plan's monthly answers; past the hard cap (110 % of the limit) the request answers 429 with type "answer-limit-reached" until the next month. Conversations are not stored.

Parameters

Answer a question from a site's knowledge: Parameters
Field	Type	Description
`siteId`path · required	string (≤ 64 chars)	Site id (site_…).

Request body (AskRequest)

Answer a question from a site's knowledge: Request body
Field	Type	Description
`question`required	string (≤ 2,000 chars)	The question, as a visitor would ask it.
`locale`optional	string (≤ 35 chars)	BCP 47 language for short questions whose language cannot be told (e.g. `de`).

Responses

200The answer. (AskAnswer)
400Invalid input (type "validation"; field names the input).
401Missing, expired or revoked credentials (types "unauthorized", "token-expired", "invalid-token").
403Authenticated but not allowed (types "forbidden", "origin-not-allowed", "api-key-not-accepted", "email-mismatch"; P36 "insufficient-scope", "not-in-plan", "coming-soon").
404Not found, or not visible to the caller (type "not-found").
429Too many requests (type "rate-limited"); retry after the Retry-After header.
503The feature is not configured on this server (type "unavailable").
504The answer took too long (type "timeout"); try again.
defaultAn error, as RFC 9457 problem details.

Shell

curl -X POST https://api.asdk.com/v1/sites/{siteId}/ask \
  -H "Authorization: Bearer $ASDK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"question":"…"}'

Conversations

Conversations of the widget, read and reviewed in the dashboard.

List conversations

GET/v1/workspaces/{id}/conversations· Read

Any member or an API key. Conversations with at least one message, latest activity first, a page at a time. q searches message texts and the lead's email and name.

Parameters

List conversations: Parameters
Field	Type	Description
`id`path · required	string (≤ 64 chars)	Workspace id (wsp_…).
`siteId`query · optional	string (≤ 64 chars)	Only this site of the workspace (site_…); all sites when absent.
`agent`query · optional	"chat" \| "sales" \| "search" \| "forms" \| "voice"
`unanswered`query · optional	boolean	Only conversations with an answer that was not grounded in the site's content.
`withLead`query · optional	boolean	Only conversations where the visitor left contact details.
`unreviewed`query · optional	boolean	Only conversations nobody marked reviewed.
`previews`query · optional	"include" \| "exclude" \| "only"	Conversations and leads from the dashboard's preview — include (default), exclude or only.
`q`query · optional	string (≤ 200 chars)	Case-insensitive text search.
`cursor`query · optional	string (≤ 4,096 chars)	The `nextCursor` of the previous page.
`limit`query · optional	integer (1–200)	Items per page (default 50).

Responses

200A page of conversations. (ConversationList)
400Invalid input (type "validation"; field names the input).
401Missing, expired or revoked credentials (types "unauthorized", "token-expired", "invalid-token").
404Not found, or not visible to the caller (type "not-found").
defaultAn error, as RFC 9457 problem details.

Shell

curl https://api.asdk.com/v1/workspaces/{id}/conversations \
  -H "Authorization: Bearer $ASDK_API_KEY"

A conversation

GET/v1/workspaces/{id}/conversations/{conversationId}· Read

Any member or an API key. Every message with its sources and the visitor's rating, the visitor, and the leads left in it.

Parameters

A conversation: Parameters
Field	Type	Description
`id`path · required	string (≤ 64 chars)	Workspace id (wsp_…).
`conversationId`path · required	string (≤ 64 chars)	Conversation id (conv_…).

Responses

200The conversation. (ConversationDetail)
401Missing, expired or revoked credentials (types "unauthorized", "token-expired", "invalid-token").
404Not found, or not visible to the caller (type "not-found").
defaultAn error, as RFC 9457 problem details.

Shell

curl https://api.asdk.com/v1/workspaces/{id}/conversations/{conversationId} \
  -H "Authorization: Bearer $ASDK_API_KEY"

Leads

Contact details visitors left, their status and CSV export.

List leads

GET/v1/workspaces/{id}/leads· Read

Any member or an API key. Newest first, a page at a time, with the number of leads per status under the same filters. q searches email, name, company and note.

Parameters

List leads: Parameters
Field	Type	Description
`id`path · required	string (≤ 64 chars)	Workspace id (wsp_…).
`siteId`query · optional	string (≤ 64 chars)	Only this site of the workspace (site_…); all sites when absent.
`status`query · optional	"new" \| "contacted" \| "archived"
`previews`query · optional	"include" \| "exclude" \| "only"	Conversations and leads from the dashboard's preview — include (default), exclude or only.
`q`query · optional	string (≤ 200 chars)	Case-insensitive text search.
`cursor`query · optional	string (≤ 4,096 chars)	The `nextCursor` of the previous page.
`limit`query · optional	integer (1–200)	Items per page (default 50).

Responses

200A page of leads. (LeadList)
400Invalid input (type "validation"; field names the input).
401Missing, expired or revoked credentials (types "unauthorized", "token-expired", "invalid-token").
404Not found, or not visible to the caller (type "not-found").
defaultAn error, as RFC 9457 problem details.

Shell

curl https://api.asdk.com/v1/workspaces/{id}/leads \
  -H "Authorization: Bearer $ASDK_API_KEY"

Export leads as CSV

GET/v1/workspaces/{id}/leads/export· Read

Any member or an API key. The leads matching the filters, newest first, at most 50,000: UTF-8 with a byte order mark, RFC 4180 quoting, and every cell that starts with =, +, -, @, a tab or a carriage return prefixed with an apostrophe so spreadsheets never run it as a formula.

Parameters

Export leads as CSV: Parameters
Field	Type	Description
`id`path · required	string (≤ 64 chars)	Workspace id (wsp_…).
`siteId`query · optional	string (≤ 64 chars)	Only this site of the workspace (site_…); all sites when absent.
`status`query · optional	"new" \| "contacted" \| "archived"
`previews`query · optional	"include" \| "exclude" \| "only"	Conversations and leads from the dashboard's preview — include (default), exclude or only.
`q`query · optional	string (≤ 200 chars)	Case-insensitive text search.

Responses

200The CSV file. (string)
400Invalid input (type "validation"; field names the input).
401Missing, expired or revoked credentials (types "unauthorized", "token-expired", "invalid-token").
404Not found, or not visible to the caller (type "not-found").
defaultAn error, as RFC 9457 problem details.

Shell

curl https://api.asdk.com/v1/workspaces/{id}/leads/export \
  -H "Authorization: Bearer $ASDK_API_KEY"

A lead

GET/v1/workspaces/{id}/leads/{leadId}· Read

Any member or an API key. The lead with the conversation it was left in.

Parameters

A lead: Parameters
Field	Type	Description
`id`path · required	string (≤ 64 chars)	Workspace id (wsp_…).
`leadId`path · required	string (≤ 64 chars)	Lead id (lead_…).

Responses

200The lead. (LeadDetail)
401Missing, expired or revoked credentials (types "unauthorized", "token-expired", "invalid-token").
404Not found, or not visible to the caller (type "not-found").
defaultAn error, as RFC 9457 problem details.

Shell

curl https://api.asdk.com/v1/workspaces/{id}/leads/{leadId} \
  -H "Authorization: Bearer $ASDK_API_KEY"

Change a lead's status

PATCH/v1/workspaces/{id}/leads/{leadId}· Write scope

Any member.

Parameters

Change a lead's status: Parameters
Field	Type	Description
`id`path · required	string (≤ 64 chars)	Workspace id (wsp_…).
`leadId`path · required	string (≤ 64 chars)	Lead id (lead_…).

Request body (LeadUpdate)

Change a lead's status: Request body
Field	Type	Description
`status`required	"new" \| "contacted" \| "archived"

Responses

200The lead after the change. (LeadDetail)
400Invalid input (type "validation"; field names the input).
401Missing, expired or revoked credentials (types "unauthorized", "token-expired", "invalid-token").
403Authenticated but not allowed (types "forbidden", "origin-not-allowed", "api-key-not-accepted", "email-mismatch"; P36 "insufficient-scope", "not-in-plan", "coming-soon").
404Not found, or not visible to the caller (type "not-found").
defaultAn error, as RFC 9457 problem details.

Shell

curl -X PATCH https://api.asdk.com/v1/workspaces/{id}/leads/{leadId} \
  -H "Authorization: Bearer $ASDK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"new"}'

Insights

Overview numbers, knowledge gaps and what visitors ask.

Overview of the workspace

GET/v1/workspaces/{id}/overview· Read

Any member or an API key. Conversations, answers, grounded rate, leads and ratings of the last days days (whole days in the workspace's time zone, today included) per day and per site, the same numbers for the period before, the pages chats start on, and the number of open knowledge gaps.

Parameters

Overview of the workspace: Parameters
Field	Type	Description
`id`path · required	string (≤ 64 chars)	Workspace id (wsp_…).
`siteId`query · optional	string (≤ 64 chars)	Only this site of the workspace (site_…); all sites when absent.
`days`query · optional	7 \| 30 \| 90	The period in days, today included (default 30).

Responses

200The overview. (Overview)
400Invalid input (type "validation"; field names the input).
401Missing, expired or revoked credentials (types "unauthorized", "token-expired", "invalid-token").
404Not found, or not visible to the caller (type "not-found").
defaultAn error, as RFC 9457 problem details.

Shell

curl https://api.asdk.com/v1/workspaces/{id}/overview \
  -H "Authorization: Bearer $ASDK_API_KEY"

What visitors ask

GET/v1/workspaces/{id}/insights· Read

Any member or an API key. The questions visitors ask most (grouped by normalized text), the pages answers cite and the answers visitors rated down, over the last days days. These lists need a plan with the catalog feature insights-report; without it entitled is false, the lists are empty and minPlan names the plan to upgrade to. Knowledge gaps are in every plan (/gaps).

Parameters

What visitors ask: Parameters
Field	Type	Description
`id`path · required	string (≤ 64 chars)	Workspace id (wsp_…).
`siteId`query · optional	string (≤ 64 chars)	Only this site of the workspace (site_…); all sites when absent.
`days`query · optional	7 \| 30 \| 90	The period in days, today included (default 30).

Responses

200The insights. (Insights)
400Invalid input (type "validation"; field names the input).
401Missing, expired or revoked credentials (types "unauthorized", "token-expired", "invalid-token").
404Not found, or not visible to the caller (type "not-found").
defaultAn error, as RFC 9457 problem details.

Shell

curl https://api.asdk.com/v1/workspaces/{id}/insights \
  -H "Authorization: Bearer $ASDK_API_KEY"

List open knowledge gaps

GET/v1/workspaces/{id}/gaps· Read

Any member or an API key. Questions the knowledge base could not answer, most asked first, a page at a time.

Parameters

List open knowledge gaps: Parameters
Field	Type	Description
`id`path · required	string (≤ 64 chars)	Workspace id (wsp_…).
`siteId`query · optional	string (≤ 64 chars)	Only this site of the workspace (site_…); all sites when absent.
`cursor`query · optional	string (≤ 4,096 chars)	The `nextCursor` of the previous page.
`limit`query · optional	integer (1–200)	Items per page (default 50).

Responses

200A page of open gaps. (KnowledgeGapList)
400Invalid input (type "validation"; field names the input).
401Missing, expired or revoked credentials (types "unauthorized", "token-expired", "invalid-token").
404Not found, or not visible to the caller (type "not-found").
defaultAn error, as RFC 9457 problem details.

Shell

curl https://api.asdk.com/v1/workspaces/{id}/gaps \
  -H "Authorization: Bearer $ASDK_API_KEY"

Search analytics

The Search agent of a site — its settings and what visitors search for.

What visitors search for

GET/v1/sites/{siteId}/search/analytics· Read

Any member, or a workspace API key. Searches visitors settled on in the last days days (UTC, today included): totals with the click-through rate (clicked searches among those with results), every day of the period, the top searches, and the searches that found nothing useful — no result or only weak ones, and no answer — that were not answered since.

Parameters

What visitors search for: Parameters
Field	Type	Description
`siteId`path · required	string (≤ 64 chars)	Site id (site_…).
`days`query · optional	integer (1–365)	Length of the period in days (default 30).
`limit`query · optional	integer (1–50)	Rows per query list (default 20).

Responses

200The analytics. (SearchAnalytics)
401Missing, expired or revoked credentials (types "unauthorized", "token-expired", "invalid-token").
403Authenticated but not allowed (types "forbidden", "origin-not-allowed", "api-key-not-accepted", "email-mismatch"; P36 "insufficient-scope", "not-in-plan", "coming-soon").
404Not found, or not visible to the caller (type "not-found").
defaultAn error, as RFC 9457 problem details.

Shell

curl https://api.asdk.com/v1/sites/{siteId}/search/analytics \
  -H "Authorization: Bearer $ASDK_API_KEY"

Webhooks

Workspace webhooks — signed events for leads, conversations, knowledge gaps and source syncs.

List webhook endpoints

GET/v1/workspaces/{id}/webhooks· Read

Owners, admins and API keys. The workspace's endpoints, the events they can subscribe to, and whether the plan includes webhooks (entitled; without them endpoints are kept but receive nothing).

Parameters

List webhook endpoints: Parameters
Field	Type	Description
`id`path · required	string (≤ 64 chars)	Workspace id (wsp_…).

Responses

200The endpoints. (WebhookEndpointList)
401Missing, expired or revoked credentials (types "unauthorized", "token-expired", "invalid-token").
403Authenticated but not allowed (types "forbidden", "origin-not-allowed", "api-key-not-accepted", "email-mismatch"; P36 "insufficient-scope", "not-in-plan", "coming-soon").
404Not found, or not visible to the caller (type "not-found").
defaultAn error, as RFC 9457 problem details.

Shell

curl https://api.asdk.com/v1/workspaces/{id}/webhooks \
  -H "Authorization: Bearer $ASDK_API_KEY"

Add a webhook endpoint

POST/v1/workspaces/{id}/webhooks· Write scope

Owners, admins and API keys with the write scope (Zapier- and Make-style subscriptions). The answer carries the signing secret, shown this once. At most 10 endpoints per workspace (limit-reached); the plan must include webhooks (not-in-plan). The address must be public https.

Parameters

Add a webhook endpoint: Parameters
Field	Type	Description
`id`path · required	string (≤ 64 chars)	Workspace id (wsp_…).

Request body (WebhookEndpointInput)

Add a webhook endpoint: Request body
Field	Type	Description
`url`required	string (≤ 2,048 chars)	A public https address.
`description`optional	string (≤ 120 chars)
`events`required	array of "lead.created" \| "lead.updated" \| "conversation.closed" \| "knowledge_gap.created" \| "source.synced"

Responses

201The endpoint and its secret. (CreatedWebhookEndpoint)
400Invalid input (type "validation"; field names the input).
401Missing, expired or revoked credentials (types "unauthorized", "token-expired", "invalid-token").
403Authenticated but not allowed (types "forbidden", "origin-not-allowed", "api-key-not-accepted", "email-mismatch"; P36 "insufficient-scope", "not-in-plan", "coming-soon").
404Not found, or not visible to the caller (type "not-found").
409Conflicts with the current state (types "already-member", "last-owner", "limit-reached", "refresh-conflict").
defaultAn error, as RFC 9457 problem details.

Shell

curl -X POST https://api.asdk.com/v1/workspaces/{id}/webhooks \
  -H "Authorization: Bearer $ASDK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"…","events":["lead.created"]}'

Change a webhook endpoint

PATCH/v1/workspaces/{id}/webhooks/{webhookId}· Write scope

Owners, admins and API keys with the write scope. Switching an endpoint on (enabled: true) also clears a stop after repeated failures.

Parameters

Change a webhook endpoint: Parameters
Field	Type	Description
`id`path · required	string (≤ 64 chars)	Workspace id (wsp_…).
`webhookId`path · required	string (≤ 64 chars)	Webhook endpoint id (whk_…).

Request body (WebhookEndpointPatch)

Change a webhook endpoint: Request body
Field	Type	Description
`url`optional	string (≤ 2,048 chars)
`description`optional	string (≤ 120 chars)
`events`optional	array of "lead.created" \| "lead.updated" \| "conversation.closed" \| "knowledge_gap.created" \| "source.synced"
`enabled`optional	boolean

Responses

200The endpoint after the change. (WebhookEndpoint)
400Invalid input (type "validation"; field names the input).
401Missing, expired or revoked credentials (types "unauthorized", "token-expired", "invalid-token").
403Authenticated but not allowed (types "forbidden", "origin-not-allowed", "api-key-not-accepted", "email-mismatch"; P36 "insufficient-scope", "not-in-plan", "coming-soon").
404Not found, or not visible to the caller (type "not-found").
defaultAn error, as RFC 9457 problem details.

Shell

curl -X PATCH https://api.asdk.com/v1/workspaces/{id}/webhooks/{webhookId} \
  -H "Authorization: Bearer $ASDK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"…","description":"…","events":["lead.created"],"enabled":true}'

Remove a webhook endpoint

DELETE/v1/workspaces/{id}/webhooks/{webhookId}· Write scope

Owners, admins and API keys with the write scope. Its delivery log goes with it.

Parameters

Remove a webhook endpoint: Parameters
Field	Type	Description
`id`path · required	string (≤ 64 chars)	Workspace id (wsp_…).
`webhookId`path · required	string (≤ 64 chars)	Webhook endpoint id (whk_…).

Responses

204Removed.
401Missing, expired or revoked credentials (types "unauthorized", "token-expired", "invalid-token").
403Authenticated but not allowed (types "forbidden", "origin-not-allowed", "api-key-not-accepted", "email-mismatch"; P36 "insufficient-scope", "not-in-plan", "coming-soon").
404Not found, or not visible to the caller (type "not-found").
defaultAn error, as RFC 9457 problem details.

Shell

curl -X DELETE https://api.asdk.com/v1/workspaces/{id}/webhooks/{webhookId} \
  -H "Authorization: Bearer $ASDK_API_KEY"

Send a test event

POST/v1/workspaces/{id}/webhooks/{webhookId}/test· Write scope

Owners, admins and API keys with the write scope. Sends a signed test event now (one attempt, also to a switched-off endpoint) and answers with the logged delivery: the status the endpoint answered, the start of its answer and how long it took. The plan must include webhooks (not-in-plan).

Parameters

Send a test event: Parameters
Field	Type	Description
`id`path · required	string (≤ 64 chars)	Workspace id (wsp_…).
`webhookId`path · required	string (≤ 64 chars)	Webhook endpoint id (whk_…).

Responses

200The delivery of the test event. (WebhookDelivery)
401Missing, expired or revoked credentials (types "unauthorized", "token-expired", "invalid-token").
403Authenticated but not allowed (types "forbidden", "origin-not-allowed", "api-key-not-accepted", "email-mismatch"; P36 "insufficient-scope", "not-in-plan", "coming-soon").
404Not found, or not visible to the caller (type "not-found").
429Too many requests (type "rate-limited"); retry after the Retry-After header.
defaultAn error, as RFC 9457 problem details.

Shell

curl -X POST https://api.asdk.com/v1/workspaces/{id}/webhooks/{webhookId}/test \
  -H "Authorization: Bearer $ASDK_API_KEY"

An endpoint's delivery log

GET/v1/workspaces/{id}/webhooks/{webhookId}/deliveries· Read

Owners, admins and API keys. Newest first, a page at a time, kept 30 days, with each delivery's payload.

Parameters

An endpoint's delivery log: Parameters
Field	Type	Description
`id`path · required	string (≤ 64 chars)	Workspace id (wsp_…).
`webhookId`path · required	string (≤ 64 chars)	Webhook endpoint id (whk_…).
`cursor`query · optional	string (≤ 4,096 chars)	The `nextCursor` of the previous page.
`limit`query · optional	integer (1–100)	Deliveries per page (default 25).

Responses

200A page of deliveries. (WebhookDeliveryList)
400Invalid input (type "validation"; field names the input).
401Missing, expired or revoked credentials (types "unauthorized", "token-expired", "invalid-token").
403Authenticated but not allowed (types "forbidden", "origin-not-allowed", "api-key-not-accepted", "email-mismatch"; P36 "insufficient-scope", "not-in-plan", "coming-soon").
404Not found, or not visible to the caller (type "not-found").
defaultAn error, as RFC 9457 problem details.

Shell

curl https://api.asdk.com/v1/workspaces/{id}/webhooks/{webhookId}/deliveries \
  -H "Authorization: Bearer $ASDK_API_KEY"

Send a delivery's event again

POST/v1/workspaces/{id}/webhooks/{webhookId}/deliveries/{deliveryId}/redeliver· Write scope

Owners, admins and API keys with the write scope. One attempt now, logged as a new delivery of the same event (same body, new signature). The plan must include webhooks (not-in-plan).

Parameters

Send a delivery's event again: Parameters
Field	Type	Description
`id`path · required	string (≤ 64 chars)	Workspace id (wsp_…).
`webhookId`path · required	string (≤ 64 chars)	Webhook endpoint id (whk_…).
`deliveryId`path · required	string (≤ 64 chars)	Delivery id (whd_…).

Responses

200The new delivery. (WebhookDelivery)
401Missing, expired or revoked credentials (types "unauthorized", "token-expired", "invalid-token").
403Authenticated but not allowed (types "forbidden", "origin-not-allowed", "api-key-not-accepted", "email-mismatch"; P36 "insufficient-scope", "not-in-plan", "coming-soon").
404Not found, or not visible to the caller (type "not-found").
429Too many requests (type "rate-limited"); retry after the Retry-After header.
defaultAn error, as RFC 9457 problem details.

Shell

curl -X POST https://api.asdk.com/v1/workspaces/{id}/webhooks/{webhookId}/deliveries/{deliveryId}/redeliver \
  -H "Authorization: Bearer $ASDK_API_KEY"

Webhook events

ASDK POSTs these events as JSON to the endpoints a workspace adds (Settings → Webhooks, or the webhooks endpoints above). Each delivery is signed; see verifying webhooks for code in JavaScript, Python and Go. Any 2xx answer is a delivery; 408, 429 and 5xx are retried after 30 seconds, 2 and 10 minutes, 1 and 6 hours.

lead.created

A visitor left their contact details

Sent for every new lead (chat, forms, WebMCP). lead.preview marks leads from the dashboard's preview.

Payload: LeadWebhookEvent

Headers

lead.created: Headers
Field	Type	Description
`X-ASDK-Signature`header · required	string	`t=<unix seconds>,v1=<hex HMAC-SHA256(secret, "<t>.<raw body>")>`; during a secret rotation two `v1` values.
`X-ASDK-Event`header · required	string	The event type (also `type` in the body).
`X-ASDK-Delivery`header · required	string	The delivery id, the same on every retry (use it to drop duplicates).

lead.updated

A lead's details, status or qualification changed

data.changes names the changed fields (email, name, company, phone, note, status, qualifiedAt) and data.previous their earlier values. Score-only changes are not sent.

Payload: LeadWebhookEvent

Headers

lead.updated: Headers
Field	Type	Description
`X-ASDK-Signature`header · required	string	`t=<unix seconds>,v1=<hex HMAC-SHA256(secret, "<t>.<raw body>")>`; during a secret rotation two `v1` values.
`X-ASDK-Event`header · required	string	The event type (also `type` in the body).
`X-ASDK-Delivery`header · required	string	The delivery id, the same on every retry (use it to drop duplicates).

conversation.closed

A conversation went quiet

Sent when a conversation had no new message for 30 minutes, with its transcript (the latest 100 messages). A visitor who returns and goes quiet again closes it again.

Payload: ConversationClosedWebhookEvent

Headers

conversation.closed: Headers
Field	Type	Description
`X-ASDK-Signature`header · required	string	`t=<unix seconds>,v1=<hex HMAC-SHA256(secret, "<t>.<raw body>")>`; during a secret rotation two `v1` values.
`X-ASDK-Event`header · required	string	The event type (also `type` in the body).
`X-ASDK-Delivery`header · required	string	The delivery id, the same on every retry (use it to drop duplicates).

knowledge_gap.created

Visitors asked something the knowledge base could not answer

Sent the first time a question goes unanswered (repeats count up the same gap).

Payload: KnowledgeGapWebhookEvent

Headers

knowledge_gap.created: Headers
Field	Type	Description
`X-ASDK-Signature`header · required	string	`t=<unix seconds>,v1=<hex HMAC-SHA256(secret, "<t>.<raw body>")>`; during a secret rotation two `v1` values.
`X-ASDK-Event`header · required	string	The event type (also `type` in the body).
`X-ASDK-Delivery`header · required	string	The delivery id, the same on every retry (use it to drop duplicates).

source.synced

A knowledge source finished syncing

data.source.status is ready after a successful sync and error after a failed one (with error).

Payload: SourceSyncedWebhookEvent

Headers

source.synced: Headers
Field	Type	Description
`X-ASDK-Signature`header · required	string	`t=<unix seconds>,v1=<hex HMAC-SHA256(secret, "<t>.<raw body>")>`; during a secret rotation two `v1` values.
`X-ASDK-Event`header · required	string	The event type (also `type` in the body).
`X-ASDK-Delivery`header · required	string	The delivery id, the same on every retry (use it to drop duplicates).

Objects

AskAnswer

AskAnswer
Field	Type	Description
`answer`required	string	The answer as Markdown, in the question's language.
`sources`required	array of AskSource	The pages the answer cites.
`grounded`required	boolean	False when the knowledge base did not cover the question.
`language`optional	string	Base code of the answer's language (`en`).

AskRequest

AskRequest
Field	Type	Description
`question`required	string (≤ 2,000 chars)	The question, as a visitor would ask it.
`locale`optional	string (≤ 35 chars)	BCP 47 language for short questions whose language cannot be told (e.g. `de`).

AskSource

AskSource
Field	Type	Description
`title`required	string
`url`required	string

CitedPage

CitedPage
Field	Type	Description
`url`required	string
`title`required	string
`answers`required	integer

ConversationClosedWebhookEvent

ConversationClosedWebhookEvent
Field	Type	Description
`id`required	string
`type`required	"conversation.closed"
`createdAt`required	string (date-time)
`workspaceId`required	string
`data`required	object
`data.site`required	WebhookSite
`data.conversation`required	object
`data.conversation.id`required	string
`data.conversation.siteId`required	string
`data.conversation.visitorId`required	string
`data.conversation.agent`required	string
`data.conversation.pageUrl`required	string \| null
`data.conversation.leadId`required	string \| null
`data.conversation.startedAt`required	string (date-time)
`data.conversation.lastMessageAt`required	string (date-time)
`data.conversation.messageCount`required	integer
`data.conversation.preview`required	boolean
`data.conversation.messages`required	array of WebhookMessage
`data.conversation.messagesTruncated`required	boolean	Only the latest 100 messages are sent.
`data.conversation.dashboardUrl`optional	string

ConversationDetail

ConversationDetail
Field	Type	Description
`id`required	string
`siteId`required	string
`siteName`required	string
`siteOrigin`required	string
`agent`required	"chat" \| "sales" \| "search" \| "forms" \| "voice"
`pageUrl`optional	string
`startedAt`required	string (date-time)
`lastMessageAt`required	string (date-time)
`preview`required	boolean
`unanswered`required	boolean
`reviewedAt`optional	string (date-time)
`reviewedBy`optional	PersonRef
`visitor`required	InboxVisitor
`messages`required	array of InboxMessage	Oldest first, at most 1,000.
`leads`required	array of Lead

ConversationList

ConversationList
Field	Type	Description
`conversations`required	array of ConversationSummary
`nextCursor`optional	string

ConversationSummary

ConversationSummary
Field	Type	Description
`id`required	string
`siteId`required	string
`siteName`required	string
`siteOrigin`required	string
`agent`required	"chat" \| "sales" \| "search" \| "forms" \| "voice"
`pageUrl`optional	string	The page the conversation started on.
`startedAt`required	string (date-time)
`lastMessageAt`required	string (date-time)
`reviewedAt`optional	string (date-time)
`preview`required	boolean	Started in the dashboard's preview, not by a visitor.
`lead`optional	LeadRef
`messages`required	integer
`questions`required	integer
`unanswered`required	boolean	An answer was not grounded in the site's content.
`thumbsUp`required	integer
`thumbsDown`required	integer
`firstQuestion`required	string	The visitor's first message, shortened to 200 characters.
`lastMessage`required	string	The last message, shortened to 200 characters.
`lastMessageRole`required	"visitor" \| "agent"

CreatedWebhookEndpoint

CreatedWebhookEndpoint
Field	Type	Description
`endpoint`required	WebhookEndpoint
`secret`required	string	The signing secret (`whsec_…`). Shown once; store it now.

Document

Document
Field	Type	Description
`id`required	string
`sourceId`required	string
`siteId`required	string
`url`required	string	The page address, or the file name of an upload.
`title`required	string
`status`required	"pending" \| "indexed" \| "skipped" \| "excluded" \| "error"
`chunkCount`required	integer
`language`optional	string	ISO 639-1 code, when detected.
`error`optional	string	Why the page is skipped or failed, in words for people.
`indexedAt`optional	string (date-time)
`updatedAt`required	string (date-time)

DocumentList

DocumentList
Field	Type	Description
`documents`required	array of Document
`total`required	integer	Documents matching the filters.
`nextCursor`optional	string	Present when there are more.

DownvotedAnswer

DownvotedAnswer
Field	Type	Description
`messageId`required	string
`conversationId`required	string
`siteId`required	string
`siteName`required	string
`question`required	string
`answer`required	string
`comment`optional	string
`ratedAt`required	string (date-time)

InboxMessage

InboxMessage
Field	Type	Description
`id`required	string
`role`required	"visitor" \| "agent"
`text`required	string
`createdAt`required	string (date-time)
`sources`required	array of InboxSource
`grounded`optional	boolean	Agent answers that went through retrieval; absent for greetings.
`refusal`required	boolean	The agent said it does not know.
`rating`optional	"up" \| "down"
`ratingComment`optional	string

InboxSource

InboxSource
Field	Type	Description
`title`required	string
`url`required	string

InboxVisitor

InboxVisitor
Field	Type	Description
`id`required	string
`email`optional	string	From the site's identify call, when it made one.
`name`optional	string
`firstSeenAt`optional	string (date-time)
`otherConversations`required	integer

Insights

Insights
Field	Type	Description
`timezone`required	string
`from`required	string (date-time)
`to`required	string (date-time)
`days`required	integer
`openGaps`required	integer
`entitled`required	boolean	The plan includes "What visitors ask" insights (catalog feature insights-report).
`minPlan`required	PlanRef
`topQuestions`required	array of TopQuestion
`citedPages`required	array of CitedPage
`downvoted`required	array of DownvotedAnswer

KnowledgeGap

KnowledgeGap
Field	Type	Description
`id`required	string	The hex SHA-256 of the normalized question.
`siteId`required	string
`siteName`required	string
`question`required	string
`count`required	integer	How often visitors asked it.
`firstSeenAt`required	string (date-time)
`lastSeenAt`required	string (date-time)

KnowledgeGapList

KnowledgeGapList
Field	Type	Description
`gaps`required	array of KnowledgeGap
`total`required	integer
`nextCursor`optional	string

KnowledgeGapWebhookEvent

KnowledgeGapWebhookEvent
Field	Type	Description
`id`required	string
`type`required	"knowledge_gap.created"
`createdAt`required	string (date-time)
`workspaceId`required	string
`data`required	object
`data.site`required	WebhookSite
`data.gap`required	object
`data.gap.id`required	string	The gap's id for POST /v1/sites/{siteId}/gaps/{gapId}/answer.
`data.gap.siteId`required	string
`data.gap.question`required	string
`data.gap.count`required	integer
`data.gap.firstSeenAt`required	string (date-time)
`data.gap.lastSeenAt`required	string (date-time)
`data.gap.dashboardUrl`optional	string

KnowledgeSummary

KnowledgeSummary
Field	Type	Description
`status`required	"empty" \| "pending" \| "syncing" \| "ready" \| "error"
`sources`required	integer	Sources other than the Q&A source.
`documents`required	integer	Indexed documents (pages, files, snippets).
`chunks`required	integer
`qaPairs`required	integer
`lastSyncedAt`optional	string (date-time)

Lead

Lead
Field	Type	Description
`id`required	string
`siteId`required	string
`siteName`required	string
`siteOrigin`required	string
`conversationId`optional	string
`email`required	string
`name`optional	string
`company`optional	string
`phone`optional	string
`note`optional	string
`consent`required	boolean
`pageUrl`optional	string
`status`required	"new" \| "contacted" \| "archived"
`preview`required	boolean
`createdAt`required	string (date-time)
`statusChangedAt`optional	string (date-time)

LeadCounts

LeadCounts
Field	Type	Description
`new`required	integer
`contacted`required	integer
`archived`required	integer

LeadDetail

LeadDetail
Field	Type	Description
`lead`required	Lead
`statusChangedBy`optional	PersonRef
`conversation`optional	ConversationDetail

LeadList

LeadList
Field	Type	Description
`leads`required	array of Lead
`counts`required	LeadCounts
`nextCursor`optional	string

LeadRef

LeadRef
Field	Type	Description
`id`required	string
`email`required	string
`name`optional	string
`status`required	"new" \| "contacted" \| "archived"

LeadUpdate

LeadUpdate
Field	Type	Description
`status`required	"new" \| "contacted" \| "archived"

LeadWebhookEvent

LeadWebhookEvent
Field	Type	Description
`id`required	string
`type`required	"lead.created" \| "lead.updated"
`createdAt`required	string (date-time)
`workspaceId`required	string
`data`required	object
`data.site`required	WebhookSite
`data.lead`required	WebhookLead
`data.changes`optional	array of string	lead.updated only.
`data.previous`optional	object (any keys)	lead.updated only; the changed fields' earlier values.

LimitUsage

LimitUsage
Field	Type	Description
`used`required	integer
`limit`required	integer

Overview

Overview
Field	Type	Description
`timezone`required	string
`from`required	string (date-time)
`to`required	string (date-time)	End of today in the time zone (exclusive).
`days`required	integer
`totals`required	StatsTotals
`previous`required	StatsTotals
`series`required	array of OverviewDay	One entry per day of the period, oldest first.
`sites`required	array of OverviewSite
`topPages`required	array of PageCount	Pages visitors' conversations started on, most first (query strings dropped).
`openGaps`required	integer
`hasConversations`required	boolean	Visitors ever talked to an agent of the workspace (or the site).
`installed`required	boolean	A site has a verified installation.

OverviewDay

OverviewDay
Field	Type	Description
`date`required	string (date)	The day in the workspace's time zone.
`totals`required	StatsTotals

OverviewSite

OverviewSite
Field	Type	Description
`siteId`required	string
`name`required	string
`origin`required	string
`installedAt`optional	string (date-time)
`totals`required	StatsTotals

PageCount

PageCount
Field	Type	Description
`url`required	string
`conversations`required	integer

PersonRef

PersonRef
Field	Type	Description
`name`required	string
`email`required	string

PlanRef

PlanRef
Field	Type	Description
`id`required	string
`name`required	string

PlanUsage

PlanUsage
Field	Type	Description
`planId`required	string
`trial`optional	boolean	The limits are a running trial's (P20).
`sites`required	LimitUsage
`pages`required	LimitUsage

Problem

Problem
Field	Type	Description
`type`required	string	URI reference identifying the problem type; "about:blank" for plain HTTP errors.
`title`required	string	Short, human-readable summary of the problem type.
`status`required	integer	HTTP status code.
`detail`optional	string	Human-readable explanation of this occurrence.
`instance`optional	string	Request path the problem occurred on.
`request_id`optional	string	Request id, also returned in the X-Request-ID header.
`trace_id`optional	string	W3C trace id of the request, also returned in the X-Trace-Id header (the id to look the request up by in the tracing backend).
`field`optional	string	For type "validation", the request field that is invalid.

QaPair

QaPair
Field	Type	Description
`id`required	string
`siteId`required	string
`question`required	string
`answer`required	string
`status`required	"pending" \| "indexed" \| "error"
`error`optional	string
`createdBy`optional	PersonRef
`createdAt`required	string (date-time)
`updatedAt`required	string (date-time)

QaPairInput

QaPairInput
Field	Type	Description
`question`required	string (≤ 1,000 chars)
`answer`required	string (≤ 8,000 chars)

QaPairList

QaPairList
Field	Type	Description
`qaPairs`required	array of QaPair
`total`required	integer
`nextCursor`optional	string

SearchAnalytics

SearchAnalytics
Field	Type	Description
`siteId`required	string
`from`required	string (date)
`to`required	string (date)
`days`required	integer
`totals`required	SearchTotals
`daily`required	array of SearchDay
`topSearches`required	array of SearchQueryStat
`missedSearches`required	array of SearchQueryStat	Searches without a useful result (no result or only weak ones, no answer) that are not resolved.

SearchDay

any

SearchQueryStat

SearchQueryStat
Field	Type	Description
`id`required	string
`query`required	string	The query as a visitor last typed it.
`searches`required	integer
`zeroResults`required	integer
`lowScore`required	integer
`answers`required	integer
`clicks`required	integer
`clickThroughRate`required	number
`lastSeenAt`required	string (date-time)
`lastMissAt`optional	string (date-time)	The last search of it that found nothing useful.

SearchTotals

SearchTotals
Field	Type	Description
`searches`required	integer	Searches visitors settled on.
`zeroResults`required	integer	Of them without any result and without an answer.
`lowScore`required	integer	Of them with only weak results and without an answer.
`answers`required	integer	Of them with an answer shown.
`clicks`required	integer	Of them with a result clicked.
`clickThroughRate`required	number	clicks / (searches − zeroResults), 0–1; 0 without searches with results.

Site

Site
Field	Type	Description
`id`required	string
`workspaceId`required	string
`name`required	string
`origin`required	string	Normalized `scheme://host[:port]`.
`allowedOrigins`required	array of string	Origins whose pages may load the widget (`https://*.example.com` covers subdomains).
`status`required	"active" \| "paused"
`installVerifiedAt`optional	string (date-time)
`createdAt`required	string (date-time)
`updatedAt`required	string (date-time)
`knowledge`required	KnowledgeSummary

SiteList

SiteList
Field	Type	Description
`sites`required	array of Site
`usage`required	PlanUsage

Source

Source
Field	Type	Description
`id`required	string
`siteId`required	string
`kind`required	"crawl" \| "sitemap" \| "file" \| "qa" \| "text"
`title`required	string	What to call the source in a list (an address, a file name, a snippet title).
`status`required	"pending" \| "syncing" \| "ready" \| "error"
`config`required	SourceConfig
`stats`required	SourceStats
`error`optional	string	Why the last sync failed or stopped early, in words for people.
`lastSyncedAt`optional	string (date-time)
`nextSyncAt`optional	string (date-time)
`createdAt`required	string (date-time)
`updatedAt`required	string (date-time)

SourceConfig

The fields of the source's kind.

SourceConfig
Field	Type	Description
`url`optional	string	crawl — where reading starts; pages under its path are read.
`include`optional	array of string	crawl — only pages matching one of these path patterns.
`exclude`optional	array of string	crawl and sitemap — pages matching these path patterns are skipped.
`maxPages`optional	integer	crawl and sitemap — at most this many pages (never more than the plan allows).
`sitemapUrl`optional	string	sitemap — the sitemap or sitemap index.
`fileName`optional	string	file — the uploaded file's name.
`fileSize`optional	integer	file — size in bytes.
`contentType`optional	string	file — media type.
`title`optional	string	text — the snippet's title.
`body`optional	string	text — the snippet (only when one source is read).

SourceList

SourceList
Field	Type	Description
`sources`required	array of Source

SourceStats

Counters of the last or running sync.

SourceStats
Field	Type	Description
`found`required	integer	Pages read so far.
`indexed`required	integer	Pages in the knowledge base after the sync (unchanged ones included).
`unchanged`required	integer	Pages whose content did not change (not embedded again).
`skipped`required	integer	Pages left out (duplicates, too little text, the plan's page limit).
`failed`required	integer	Pages that could not be read.
`removed`required	integer	Pages that disappeared from the site since the last sync.
`chunks`required	integer
`limitReached`optional	boolean	The plan's page limit stopped the sync.
`startedAt`optional	string (date-time)
`finishedAt`optional	string (date-time)

SourceSyncedWebhookEvent

SourceSyncedWebhookEvent
Field	Type	Description
`id`required	string
`type`required	"source.synced"
`createdAt`required	string (date-time)
`workspaceId`required	string
`data`required	object
`data.site`required	WebhookSite
`data.source`required	object
`data.source.id`required	string
`data.source.siteId`required	string
`data.source.kind`required	"crawl" \| "sitemap" \| "file" \| "qa" \| "text"
`data.source.title`required	string
`data.source.status`required	"ready" \| "error"
`data.source.error`required	string \| null
`data.source.stats`required	object (any keys)	Pages found, indexed, unchanged, skipped, failed and removed, and chunks.
`data.source.lastSyncedAt`required	string (date-time) \| null
`data.source.nextSyncAt`required	string (date-time) \| null
`data.source.dashboardUrl`optional	string

StatsTotals

StatsTotals
Field	Type	Description
`conversations`required	integer	Visitors' conversations with at least one question, started in the period.
`answers`required	integer	Agent answers in visitors' conversations.
`measuredAnswers`required	integer	Answers that went through retrieval (greetings do not).
`groundedAnswers`required	integer	Measured answers backed by the site's content.
`groundedRate`optional	number (0–1)	groundedAnswers / measuredAnswers; absent without measured answers.
`leads`required	integer
`thumbsUp`required	integer
`thumbsDown`required	integer

TopQuestion

TopQuestion
Field	Type	Description
`text`required	string	The wording visitors used most.
`count`required	integer
`answered`required	integer	Times the answer was grounded in the site's content.
`unanswered`required	integer
`lastAskedAt`required	string (date-time)
`conversationId`required	string	The newest conversation it was asked in.
`siteId`required	string

WebhookDelivery

WebhookDelivery
Field	Type	Description
`id`required	string
`eventId`required	string
`eventType`required	string	The event type, or `test`.
`test`required	boolean
`status`required	"pending" \| "retrying" \| "delivered" \| "failed"
`attempts`required	integer
`nextAttemptAt`optional	string (date-time)
`responseStatus`optional	integer	The HTTP status of the last attempt (absent when there was no answer).
`responseBody`optional	string	The start of the endpoint's answer (1,000 characters).
`error`optional	string
`durationMs`optional	integer
`createdAt`required	string (date-time)
`lastAttemptAt`optional	string (date-time)
`deliveredAt`optional	string (date-time)
`payload`required	object (any keys)	The JSON body sent (a webhook event).

WebhookDeliveryList

WebhookDeliveryList
Field	Type	Description
`deliveries`required	array of WebhookDelivery
`nextCursor`optional	string

WebhookEndpoint

WebhookEndpoint
Field	Type	Description
`id`required	string
`url`required	string
`description`required	string
`events`required	array of "lead.created" \| "lead.updated" \| "conversation.closed" \| "knowledge_gap.created" \| "source.synced"
`enabled`required	boolean
`disabledReason`optional	"manual" \| "failing"	Why the endpoint is off; `failing` after 15 deliveries in a row failed for good.
`secretHint`required	string	The last characters of the signing secret.
`previousSecretExpiresAt`optional	string (date-time)	After a rotation, until when the previous secret also signs.
`createdAt`required	string (date-time)
`updatedAt`required	string (date-time)

WebhookEndpointInput

WebhookEndpointInput
Field	Type	Description
`url`required	string (≤ 2,048 chars)	A public https address.
`description`optional	string (≤ 120 chars)
`events`required	array of "lead.created" \| "lead.updated" \| "conversation.closed" \| "knowledge_gap.created" \| "source.synced"

WebhookEndpointList

WebhookEndpointList
Field	Type	Description
`endpoints`required	array of WebhookEndpoint
`events`required	array of "lead.created" \| "lead.updated" \| "conversation.closed" \| "knowledge_gap.created" \| "source.synced"	Every event an endpoint can subscribe to.
`entitled`required	boolean	Whether the plan includes webhooks.
`minPlan`optional	string	The cheapest plan with webhooks (when not entitled).
`maxEndpoints`required	integer

WebhookEndpointPatch

WebhookEndpointPatch
Field	Type	Description
`url`optional	string (≤ 2,048 chars)
`description`optional	string (≤ 120 chars)
`events`optional	array of "lead.created" \| "lead.updated" \| "conversation.closed" \| "knowledge_gap.created" \| "source.synced"
`enabled`optional	boolean

WebhookLead

WebhookLead
Field	Type	Description
`id`required	string
`siteId`required	string
`conversationId`required	string \| null
`email`required	string
`name`required	string \| null
`company`required	string \| null
`phone`required	string \| null
`note`required	string \| null
`consent`required	boolean
`pageUrl`required	string \| null
`status`required	"new" \| "contacted" \| "archived"
`score`required	integer \| null	The Sales agent's score, 0–100.
`qualifiedAt`required	string (date-time) \| null
`createdAt`required	string (date-time)
`preview`required	boolean	Left in the dashboard's preview, not by a visitor.
`dashboardUrl`optional	string

WebhookMessage

WebhookMessage
Field	Type	Description
`id`required	string
`role`required	"visitor" \| "agent"
`text`required	string
`sources`required	array of AskSource
`createdAt`required	string (date-time)

WebhookSite

WebhookSite
Field	Type	Description
`id`required	string
`name`required	string
`origin`required	string

Workspace

Workspace
Field	Type	Description
`id`required	string
`name`required	string
`planId`required	string	Catalog plan id (packages/catalog).
`trialEndsAt`optional	string (date-time)
`createdAt`required	string (date-time)
`role`optional	"owner" \| "admin" \| "member" \| "client"

WorkspaceSuspension

WorkspaceSuspension
Field	Type	Description
`suspended`required	boolean
`suspendedAt`optional	string (date-time)
`contact`required	string	Where to write about it.