The work an audit recommends and the record of doing it. Beta: these shapes may change; see the changelog.
GET /audits/{auditId}/action-items/counts
How many items are still suggested, by type. counts is null until a run has finished.
curl " https://api.beket.ai/api/v1/audits/AUDIT_ID/action-items/counts " \
-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.countsobject | null yes data.counts.totalinteger yes data.counts.offPageinteger yes data.counts.onPageinteger yes data.counts.technicalinteger yes
GET /audits/{auditId}/action-items/custom
Items the team added to the list, newest first. At most 200.
curl " https://api.beket.ai/api/v1/audits/AUDIT_ID/action-items/custom " \
-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.itemsUserActionItem []yes
"itemKey" : " offpage:pitch-rival-com-roundup " ,
"title" : " Pitch the widget roundup on rival.com " ,
POST /audits/{auditId}/action-items/custom
Adds an item to the list — a recommendation from the report, say — as TODO. Adding one with the key of an existing item replaces its content and keeps its status.
curl -X POST " https://api.beket.ai/api/v1/audits/AUDIT_ID/action-items/custom " \
-H " Authorization: Bearer $BEKET_API_KEY " \
-H " Content-Type: application/json " \
-d ' {"itemKey":"<itemKey>","title":"<title>","type":"<type>","impact":"<impact>"} '
Name In Required Type Description auditIdpath yes string The audit’s id.
Field Type Required Description itemKeystring yes titlestring yes subtitlestring type“on-page” | “off-page” | “technical” yes impact“low” | “medium” | “high” yes
Field Type Required Description successboolean yes dataobject yes data.itemUserActionItem yes
"itemKey" : " offpage:pitch-rival-com-roundup " ,
"title" : " Pitch the widget roundup on rival.com " ,
DELETE /audits/{auditId}/action-items/custom/{itemKey}
Removes an item the team added. Removing one that does not exist succeeds.
curl -X DELETE " https://api.beket.ai/api/v1/audits/AUDIT_ID/action-items/custom/ITEM_KEY " \
-H " Authorization: Bearer $BEKET_API_KEY "
Name In Required Type Description auditIdpath yes string The audit’s id. itemKeypath yes string The item’s key.
Field Type Required Description successboolean yes dataobject yes data.itemKeystring yes data.removedboolean yes
"itemKey" : " offpage:pitch-rival-com-roundup " ,
GET /audits/{auditId}/action-items/links
The URLs the team attached to show work shipped, each with its newest check: whether the page is live in the crawl, cited by AI answers, or ranking. At most 500.
curl " https://api.beket.ai/api/v1/audits/AUDIT_ID/action-items/links " \
-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.linksActionItemLink []yes
"id" : " d2a2ec00-64bb-4539-b6fe-59bbe4586a53 " ,
"itemKey" : " technical:add-faq-schema " ,
"url" : " https://example.com/faq " ,
"createdAt" : " 2026-10-26T19:53:04.869Z " ,
POST /audits/{auditId}/action-items/links
Attaches an http(s) URL to an item and checks it against the newest snapshot straight away. Beket never fetches the URL; the check reads the run’s data. outcome is null when there is no snapshot yet or the check failed.
curl -X POST " https://api.beket.ai/api/v1/audits/AUDIT_ID/action-items/links " \
-H " Authorization: Bearer $BEKET_API_KEY " \
-H " Content-Type: application/json " \
-d ' {"itemKey":"<itemKey>","url":"<url>"} '
Name In Required Type Description auditIdpath yes string The audit’s id.
Field Type Required Description itemKeystring yes urlstring yes An absolute http(s) URL. labelstring
Field Type Required Description successboolean yes dataobject yes data.linkActionItemLink yes
"id" : " 35e17430-c4ad-4a24-90f8-aa488cb2d915 " ,
"itemKey" : " technical:add-faq-schema " ,
"url" : " https://example.com/pricing " ,
"createdAt" : " 2026-10-26T19:53:05.505Z " ,
"crawlDetail" : " not in this crawl yet " ,
"checkedAt" : " 2026-10-26T19:53:05.512Z "
DELETE /audits/{auditId}/action-items/links/{linkId}
Removes a link. Removing one that does not exist succeeds.
curl -X DELETE " https://api.beket.ai/api/v1/audits/AUDIT_ID/action-items/links/LINK_ID " \
-H " Authorization: Bearer $BEKET_API_KEY "
Name In Required Type Description auditIdpath yes string The audit’s id. linkIdpath yes string The link’s id.
Field Type Required Description successboolean yes dataobject yes data.linkIdstring yes data.removedboolean yes
"linkId" : " 35e17430-c4ad-4a24-90f8-aa488cb2d915 " ,
GET /audits/{auditId}/action-items/priority
The few suggested items worth doing first, ranked, with the technical quick wins and two totals. priority is null until a run has finished.
curl " https://api.beket.ai/api/v1/audits/AUDIT_ID/action-items/priority " \
-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.priorityobject | null yes data.priority.itemsobject[] yes At most 5, best first. data.priority.items[].keystring yes data.priority.items[].titlestring yes data.priority.items[].domainstring | null data.priority.items[].type“on-page” | “off-page” | “technical” yes data.priority.items[].impact“low” | “medium” | “high” yes data.priority.items[].promptCountinteger data.priority.items[].promptCountCappedboolean The count is a floor — show it as “5+”. data.priority.items[].rivalCitedboolean data.priority.items[].openTerritoryboolean data.priority.items[].scorenumber yes data.priority.items[].relatedinteger Other suggested items folded into this one (same domain). data.priority.items[].hookobject | null Why it ranks: kind is cited, roundup, open_territory or low_hanging_fruit. data.priority.quickWinsobject yes data.priority.quickWins.totalinteger yes data.priority.quickWins.itemsobject[] yes At most 10. data.priority.quickWins.items[].keystring yes data.priority.quickWins.items[].titlestring yes data.priority.highImpactinteger yes Suggested items of high impact. data.priority.totalSuggestedinteger yes
POST /audits/{auditId}/action-items/quote
Asks the Beket team to price one off-site item — an engagement or citation-gap item. This contacts the Beket team , who reply by email and in the quote’s replies. Answers 201 for a new request and 200 with the existing one when the item was already requested. Needs a user’s API key: a request is answered to a person.
curl -X POST " https://api.beket.ai/api/v1/audits/AUDIT_ID/action-items/quote " \
-H " Authorization: Bearer $BEKET_API_KEY " \
-H " Content-Type: application/json " \
-d ' {"itemKey":"<itemKey>"} '
Name In Required Type Description auditIdpath yes string The audit’s id.
Field Type Required Description itemKeystring yes notestring | null
GET /audits/{auditId}/action-items/quotes
Every quote requested on this audit, with Beket’s replies.
curl " https://api.beket.ai/api/v1/audits/AUDIT_ID/action-items/quotes " \
-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.quotesActionItemQuote []yes
"id" : " ebb4822e-e3a9-4270-8ec9-df946825336d " ,
"itemKey" : " offpage:pitch-rival-com-roundup " ,
"itemTitle" : " Get listed in the rival.com widget roundup " ,
"itemSummary" : " rival.com is cited for 3 prompts where Example Co is absent. " ,
"sentAt" : " 2026-10-20T12:00:00.000Z " ,
"sentBy" : " clrecorderuser00000000001 " ,
"message" : " We can place this within two weeks. " ,
"createdAt" : " 2026-10-26T19:53:04.872Z "
GET /audits/{auditId}/action-items/status
Every item the team moved off SUGGESTED. An item not listed is SUGGESTED.
curl " https://api.beket.ai/api/v1/audits/AUDIT_ID/action-items/status " \
-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.statusesobject[] yes data.statuses[].itemKeystring yes data.statuses[].status“TODO” | “DONE” | “ARCHIVED” yes data.statuses[].doneAtstring | null yes When it was marked DONE. data.statuses[].doneTitlestring | null yes Its title when it was marked DONE. data.statuses[].resultobject | null yes What marking it done changed. null unless DONE. data.statuses[].result.state“untracked” | “measuring” | “no-run” | “settled” yes data.statuses[].result.measurableFromstring Only while measuring: the first run that can show the effect. data.statuses[].result.outcomeobject Only when settled: the before-and-after reading.
"itemKey" : " technical:add-faq-schema " ,
"doneAt" : " 2026-10-26T19:53:05.451Z " ,
"doneTitle" : " Add FAQ schema to the pricing page " ,
"measurableFrom" : " 2026-11-02T19:53:05.451Z "
PATCH /audits/{auditId}/action-items/status
Moves one item to TODO, DONE or ARCHIVED, or back to SUGGESTED, which clears it. title is kept only on the move to DONE, so the item still lists after the report rewords it.
curl -X PATCH " https://api.beket.ai/api/v1/audits/AUDIT_ID/action-items/status " \
-H " Authorization: Bearer $BEKET_API_KEY " \
-H " Content-Type: application/json " \
-d ' {"itemKey":"<itemKey>","status":"<status>"} '
Name In Required Type Description auditIdpath yes string The audit’s id.
Field Type Required Description itemKeystring yes status“SUGGESTED” | “TODO” | “DONE” | “ARCHIVED” yes titlestring
Field Type Required Description successboolean yes dataobject yes data.itemKeystring yes data.status“SUGGESTED” | “TODO” | “DONE” | “ARCHIVED” yes
"itemKey" : " technical:add-faq-schema " ,
GET /audits/{auditId}/indexnow
The key the site hosts so search engines accept its IndexNow pings, and whether Beket has found it live.
curl " https://api.beket.ai/api/v1/audits/AUDIT_ID/indexnow " \
-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.keystring | null yes null until a key is issued.data.keyLocationstring | null yes The URL the key file must answer at. data.hoststring | null yes null until the site is crawled.data.verifiedAtstring | null yes data.filestring | null yes The path to host the key file at.
POST /audits/{auditId}/indexnow/verify
Issues a key if there is none, then fetches the key file from the site and records verifiedAt when it matches. verified: false means the file is not live yet — host contents at file.
curl -X POST " https://api.beket.ai/api/v1/audits/AUDIT_ID/indexnow/verify " \
-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.verifiedboolean yes data.keystring yes data.keyLocationstring yes The URL the key file must answer at. data.hoststring yes data.verifiedAtstring | null yes Set by this check when it matched, or by an earlier one. data.filestring yes The path to host the key file at. data.contentsstring yes The exact contents the file must hold.
Field Type Required Description idstring yes itemKeystring yes urlstring yes labelstring | null yes firstVerifiedAtstring | null yes The first time a run found the link live or cited. createdAtstring yes outcomeobject | null yes The newest check against the latest snapshot; null until one ran. outcome.crawlVisibleboolean | null yes On the audited site: present in the crawl and answering 2xx/3xx. null off-site. outcome.crawlDetailstring | null outcome.crawlAgeDaysinteger | null Age of the crawl this was measured against. outcome.citedboolean | null yes AI answers cited this exact URL. outcome.domainCitedboolean | null AI answers cited its domain. Off-site links only. outcome.rankingboolean | null The page ranks in search. On-site links only. outcome.positioninteger | null outcome.checkedAtstring yes
Field Type Required Description idstring yes itemKeystring yes status“REQUESTED” | “QUOTED” | “NEEDS_CALL” | “DECLINED” yes itemTitlestring yes The item as it read when the quote was requested. itemSummarystring | null notestring | null repliesobject[] yes Beket’s answers, oldest first. replies[].outcome“QUOTED” | “NEEDS_CALL” | “DECLINED” yes replies[].priceCentsinteger | null yes Set only on a QUOTED reply. replies[].messagestring yes replies[].sentBystring replies[].sentAtstring yes createdAtstring yes
Field Type Required Description itemKeystring yes titlestring yes subtitlestring | null yes type“on-page” | “off-page” | “technical” yes impact“low” | “medium” | “high” yes