What an audit measures against: competitors, languages and location, and the daily snapshot. Beta: these shapes may change; see the changelog.
GET /angles
The active angles — the categories prompts are filed under — in display order.
curl " https://api.beket.ai/api/v1/angles " \
-H " Authorization: Bearer $BEKET_API_KEY "
Field Type Required Description successboolean yes dataobject yes data.anglesobject[] yes data.angles[].idstring yes data.angles[].labelstring yes data.angles[].groupstring
"id" : " angle-winnable-queries-int-test " ,
"label" : " winnable int test " ,
"group" : " AWARENESS_DISCOVERY "
"id" : " RETENTION_EXPANSION " ,
"label" : " Retention / Expansion " ,
GET /audits/{auditId}/changes
Who changed the audit’s profile, competitors, prompts, topics, facts, engines or targeting, and what changed, newest first. At most 200.
curl " https://api.beket.ai/api/v1/audits/AUDIT_ID/changes " \
-H " Authorization: Bearer $BEKET_API_KEY "
Name In Required Type Description auditIdpath yes string The audit’s id.
Field Type Required Description successboolean yes dataobject yes data.changesobject[] yes data.changes[].idstring yes data.changes[].entityType“profile” | “competitor” | “query” | “connectors” | “targeting” | “topic” | “brandFact” yes data.changes[].action“create” | “update” | “delete” yes data.changes[].fieldstring | null yes The field edited; null for a whole-row create or delete. data.changes[].oldValueobject yes The value before, in the field’s own JSON shape. data.changes[].newValueobject yes The value after, in the field’s own JSON shape. data.changes[].actorEmailstring | null yes data.changes[].actingAsOrgIdstring | null yes Set when Beket support made the change on your behalf. data.changes[].createdAtstring yes
"id" : " fca6152b-ff37-45b4-9b30-84f1e4ac9539 " ,
"entityType" : " brandFact " ,
"id" : " 0cbd0f1b-9921-4eb3-ac83-38789de11596 " ,
"id" : " 0cbd0f1b-9921-4eb3-ac83-38789de11596 " ,
"actorEmail" : " redacted@example.com " ,
"createdAt" : " 2026-10-26T19:53:05.436Z "
"id" : " ff168e1d-ec64-4cf7-958b-f36c9a8e6e43 " ,
"entityType" : " brandFact " ,
"id" : " c47baa43-276c-45d4-93d5-09a3e26a7580 " ,
"value" : " Family owned since 1998 "
"actorEmail" : " redacted@example.com " ,
"createdAt" : " 2026-10-26T19:53:05.424Z "
GET /audits/{auditId}/competitors
The competitors this audit compares the brand against — the list a person curated. Names a run discovered on its own are not in it.
curl " https://api.beket.ai/api/v1/audits/AUDIT_ID/competitors " \
-H " Authorization: Bearer $BEKET_API_KEY "
Name In Required Type Description auditIdpath yes string The audit’s id.
PATCH /audits/{auditId}/competitors
Replaces the curated list. Entries are trimmed, their domains normalized, and duplicates by name collapsed, so the response may hold fewer than you sent. Mention metrics are recomputed in the background. Market audits have no competitors to edit.
curl -X PATCH " https://api.beket.ai/api/v1/audits/AUDIT_ID/competitors " \
-H " Authorization: Bearer $BEKET_API_KEY " \
-H " Content-Type: application/json " \
Name In Required Type Description auditIdpath yes string The audit’s id.
Field Type Required Description competitorsobject[] yes competitors[].namestring yes competitors[].domainstring | null The competitor’s site, like domain.com. Blank or null when it has none; anything else that is not a plausible host is a 400. competitors[].sizeTier“startup” | “smb” | “mid-market” | “enterprise” | “unknown” competitors[].classification“direct” | “indirect” | “not-competitor” competitors[].evidencestring | null
POST /audits/{auditId}/entities/import
Applies many edits from a CSV with the header name,type,merge_into, at most 500 rows and 200,000 characters. All or none: if any row is refused, nothing is applied and the 422 lists the refused rows in error.details.rows.
curl -X POST " https://api.beket.ai/api/v1/audits/AUDIT_ID/entities/import " \
-H " Authorization: Bearer $BEKET_API_KEY " \
-H " Content-Type: application/json " \
Name In Required Type Description auditIdpath yes string The audit’s id.
Field Type Required Description csvstring yes
Field Type Required Description successboolean yes dataobject yes data.rowsobject[] yes data.rows[].lineinteger yes data.rows[].namestring yes data.rows[].status“applied” | “unchanged” yes
PUT /audits/{auditId}/entities/merge
Records the name as another spelling of the competitor into, so its mentions count for that competitor. into: null unmerges it.
curl -X PUT " https://api.beket.ai/api/v1/audits/AUDIT_ID/entities/merge " \
-H " Authorization: Bearer $BEKET_API_KEY " \
-H " Content-Type: application/json " \
-d ' {"name":"<name>","into":"<into>"} '
Name In Required Type Description auditIdpath yes string The audit’s id.
Field Type Required Description namestring yes intostring | null yes
GET /audits/{auditId}/entities/review
The names AI answers mention that are neither the brand nor a curated competitor, most mentioned first, at most 100 per page. Each carries the competitors it may be another spelling of.
curl " https://api.beket.ai/api/v1/audits/AUDIT_ID/entities/review?q=Q&status=STATUS " \
-H " Authorization: Bearer $BEKET_API_KEY "
Name In Required Type Description auditIdpath yes string The audit’s id. qquery no string Only names containing this text. statusquery no “pending” | “overridden” | “all” pending (the default): names not yet given a type; overridden: names given one; all: both.offsetquery no integer Names to skip. Default 0. limitquery no integer Names per page, 1–100. Default 100.
Field Type Required Description successboolean yes dataobject yes data.entitiesobject[] yes data.entities[].nameKeystring yes data.entities[].namestring yes The most common spelling. data.entities[].mentionsinteger yes data.entities[].answersinteger yes data.entities[].kind“brand” | “competitor” | “place” | “ai_platform” | “person” | “publisher” | “generic” yes data.entities[].override“place” | “ai_platform” | “person” | “publisher” | “generic” | null yes data.entities[].suggestionsobject[] yes data.entities[].suggestions[].namestring yes data.entities[].suggestions[].reason“same_name” | “contains_name” yes data.totalinteger yes data.offsetinteger yes data.limitinteger yes
"nameKey" : " n:widgethub " ,
PUT /audits/{auditId}/entities/type
Marks a name as something other than a competitor, so the report stops counting it as one. kind: null clears the override.
curl -X PUT " https://api.beket.ai/api/v1/audits/AUDIT_ID/entities/type " \
-H " Authorization: Bearer $BEKET_API_KEY " \
-H " Content-Type: application/json " \
-d ' {"name":"<name>","kind":"<kind>"} '
Name In Required Type Description auditIdpath yes string The audit’s id.
Field Type Required Description namestring yes kind“place” | “ai_platform” | “person” | “publisher” | “generic” | null yes
"nameKey" : " n:widgethub " ,
GET /audits/{auditId}/profile/gbp-suggestion
A best guess at the brand’s own Google Business Profile, looked up on Google Maps from its name and city, for you to confirm. null when nothing matched, when the profile already names one, or when the audit has no brand profile — never an error.
curl " https://api.beket.ai/api/v1/audits/AUDIT_ID/profile/gbp-suggestion " \
-H " Authorization: Bearer $BEKET_API_KEY "
Name In Required Type Description auditIdpath yes string The audit’s id.
Field Type Required Description successboolean yes dataobject yes data.suggestionobject | null yes data.suggestion.placeIdstring yes data.suggestion.namestring yes data.suggestion.formattedAddressstring | null data.suggestion.phonestring | null
PATCH /audits/{auditId}/schedule
Toggles the daily snapshot and sets the time zone whose night it runs in. The zone applies whether or not a schedule exists yet; the toggle needs one, which an audit gets after its first full run. The schedule fields are absent until then.
curl -X PATCH " https://api.beket.ai/api/v1/audits/AUDIT_ID/schedule " \
-H " Authorization: Bearer $BEKET_API_KEY " \
-H " Content-Type: application/json " \
-d ' {"snapshotEnabled":true} '
Name In Required Type Description auditIdpath yes string The audit’s id.
Field Type Required Description snapshotEnabledboolean snapshotTimeZonestring | null The time zone whose night the daily snapshot runs in, as an IANA name (Europe/Berlin). null removes the override, so the organization’s zone applies.
Field Type Required Description successboolean yes dataobject yes data.auditIdstring data.intervalHoursinteger data.snapshotLabelPrefixstring | null data.optionsobject The run options each scheduled run uses. data.createdAtstring data.nextRunAtstring data.runCountinteger data.lastErrorstring | null data.snapshotEnabledboolean Whether the daily snapshot runs. data.snapshotTimeZonestring | null yes This audit’s own zone override; null when it has none. data.resolvedSnapshotTimeZonestring yes The zone that actually applies — the override, or the organization’s.
"snapshotTimeZone" : " America/New_York " ,
"resolvedSnapshotTimeZone" : " America/New_York "
GET /audits/{auditId}/targeting
The languages prompts are written in and the location answers are requested from.
curl " https://api.beket.ai/api/v1/audits/AUDIT_ID/targeting " \
-H " Authorization: Bearer $BEKET_API_KEY "
Name In Required Type Description auditIdpath yes string The audit’s id.
"locationSuggestions" : []
PATCH /audits/{auditId}/targeting
Replaces the languages and location. Languages may be sent as names (English) or codes; they are stored and returned as ISO 639-1 codes. Applies to prompts generated and runs started after the change.
curl -X PATCH " https://api.beket.ai/api/v1/audits/AUDIT_ID/targeting " \
-H " Authorization: Bearer $BEKET_API_KEY " \
-H " Content-Type: application/json " \
Name In Required Type Description auditIdpath yes string The audit’s id.
Field Type Required Description languagesstring[] locationsstring[]
"locationSuggestions" : []
Field Type Required Description competitorsobject[] yes competitors[].namestring yes competitors[].domainstring | null yes competitors[].sizeTier“startup” | “smb” | “mid-market” | “enterprise” | “unknown” competitors[].classification“direct” | “indirect” | “not-competitor” not-competitor is a person’s verdict; a run never overrides it.competitors[].evidencestring | null Why this is a competitor. Absent until a run surfaces evidence.
Field Type Required Description languagesstring[] yes ISO 639-1 codes the prompts are written in. locationsstring[] yes The location answers are requested from. At most one. languageSuggestionsstring[] yes Languages that fit this audit, for a picker. locationSuggestionsstring[] yes Locations that fit this audit, for a picker.
Field Type Required Description nameKeystring | null yes The key the name files under. outcome“applied” | “unchanged” yes unchanged when the name already read that way; nothing was written.