HTTP routes an account can call
Generated by node scripts/api-catalog.cjs from app/api/**/route.ts; do not edit by hand.
569 routes admit an account caller (an acc_ key or an account sign-in); 30 can answer 402; 26 carry the usage receipt header; 230 are named by an account-visible MCP tool.
Auth headers, scopes, the 402 bodies and the receipt are explained in api-for-accounts.md; prices in self-serve-billing-api.md.
Columns:
- Methods: the HTTP methods the route file exports.
- Scope: the scopes a key can hold that the route file names. A key needs the one the method it calls demands; a miss is
403SCOPE_DENIED.nonemeans the file names no scope: any active key of the account may call it. - 402: the route checks money before it works and can refuse with a 402 body.
- Receipt: a 2xx answer carries
X-Linkio-Usage-Receiptfor a key that holdsbilling:read. - Access:
key= anacc_key or an account sign-in;self-serve key= a managed account's key gets403ACCOUNT_TYPE_DENIED;session only= the route admits an account sign-in but no key reaches it;session only (scope)= the route demands a scope no self-serve key can hold, so a key gets403SCOPE_DENIED. - Tools: the MCP tools whose request path is this route. This column is route-level: a tool often calls the
/api/internal/...twin of a/api/clients/...route, so a route with no tool is not by itself a gap. The tool catalog (mcp-tools-for-accounts.md) is the parity source.
/api/account (90)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET PUT | /api/account/access-token | orders:read orders:write | key | |||
| GET | /api/account/activity | orders:read | key | account_activity_feed | ||
| GET | /api/account/all-problems | orders:read | key | |||
| GET POST DELETE | /api/account/api-keys | client-config:read client-config:write | key | account_api_key_revoke account_api_keys_list | ||
| PUT DELETE | /api/account/api-keys/[id]/limits | billing:write | key | usage_api_key_caps_set | ||
| GET | /api/account/backlink-health | orders:read | key | |||
| POST | /api/account/backlink-health/[id]/dispute | orders:write | key | |||
| POST | /api/account/backlink-health/[id]/recheck | orders:write | key | |||
| GET | /api/account/backlink-health/sla-breaches | orders:read | key | |||
| POST | /api/account/backlink-health/sla-resolution | orders:write | key | |||
| GET PATCH | /api/account/billing-mode | client-config:read client-config:write | key | account_billing_mode | ||
| GET POST DELETE | /api/account/billing/card | billing:read billing:write | key | usage_billing_card_get usage_billing_card_remove | ||
| POST | /api/account/billing/card/confirm | billing:write | key | |||
| POST | /api/account/billing/card/setup-link | billing:write | key | usage_billing_card_setup_link | ||
| GET | /api/account/billing/charges | billing:read | key | usage_billing_charges_list | ||
| GET | /api/account/billing/charges/[id]/confirm | billing:write | key | |||
| POST | /api/account/billing/charges/[id]/sync | billing:write | key | usage_billing_charge_sync | ||
| GET | /api/account/billing/ledger | billing:read | key | usage_billing_ledger | ||
| POST | /api/account/billing/pay-now | billing:write | key | usage_billing_pay_now | ||
| GET | /api/account/brand-stats | orders:read | key | |||
| GET POST | /api/account/campaigns | account-campaign:read account-campaign:write | key | |||
| GET PATCH | /api/account/campaigns/[id] | account-campaign:read account-campaign:write | key | |||
| GET | /api/account/claim-status | orders:read | key | |||
| GET | /api/account/clients | orders:read | key | |||
| POST | /api/account/collaborative-placement-request | orders:write | self-serve key | |||
| GET PATCH | /api/account/communication-settings | client-config:read client-config:write | key | |||
| GET | /api/account/consolidated-reports | orders:read | key | |||
| GET | /api/account/consolidated-reports/check | orders:read | key | |||
| GET | /api/account/credits/balance | orders:read | key | |||
| GET | /api/account/credits/by-month | orders:read | key | credits_by_month | ||
| POST | /api/account/credits/convert | billing:write | key | credits_convert | ||
| GET | /api/account/credits/summary | orders:read | 402 | key | credits_summary | |
| GET | /api/account/credits/transactions | orders:read | key | credits_transactions | ||
| GET | /api/account/credits/workflow-usage | orders:read | key | credits_workflow_usage | ||
| GET PATCH | /api/account/dashboard-preferences | client-config:read client-config:write | key | |||
| GET | /api/account/dashboard-summary | orders:read | key | |||
| GET | /api/account/debug-clients | orders:read | key | |||
| GET | /api/account/deliverables | orders:read | key | |||
| POST | /api/account/deliverables/[lineItemId]/qa-feedback | orders:write | key | |||
| POST | /api/account/deliverables/[lineItemId]/qa-reply | orders:write | key | |||
| GET | /api/account/deliverables/enriched | orders:read | key | |||
| GET | /api/account/deliverables/historical | orders:read | key | |||
| GET | /api/account/deliverables/orphans | orders:read | key | |||
| GET | /api/account/deliverables/summary | orders:read | key | |||
| GET | /api/account/llm-tracking | llm-tracking:read | key | account_llm_tracking_summary | ||
| GET | /api/account/llm-tracking/backlinks | llm-tracking:read | key | account_llm_tracking_backlinks | ||
| GET | /api/account/llm-tracking/export | llm-tracking:read | key | account_llm_tracking_export | ||
| GET | /api/account/my-collaborative-placements | orders:read | key | |||
| GET | /api/account/onboarding-state | orders:read | key | |||
| POST DELETE | /api/account/orders/[id]/backup-preferences | orders:write | key | |||
| GET | /api/account/orders/[id]/backups | orders:read | key | |||
| POST | /api/account/orders/[id]/cross-order-replace | orders:write | key | |||
| GET | /api/account/orders/[id]/problems | orders:read | key | |||
| GET POST | /api/account/orders/[id]/replacement-feedback | orders:read orders:write | key | |||
| GET | /api/account/orders/[id]/replacement-history | orders:read | key | |||
| GET | /api/account/orders/[id]/replacement-pool | orders:read | key | |||
| GET POST | /api/account/orders/[id]/replacement-wizard/[lineItemId] | orders:write | key | |||
| POST | /api/account/orders/[id]/replacements | orders:write | key | |||
| GET | /api/account/orders/[id]/reports | orders:read | key | |||
| GET PATCH | /api/account/partner | client-config:read client-config:write | key | |||
| GET | /api/account/partner/export | client-config:read | key | |||
| GET POST | /api/account/partner/referrals | client-config:read client-config:write | key | |||
| GET PUT | /api/account/profile | client-config:read client-config:write | key | account_me | ||
| POST | /api/account/proposal-request | orders:write | key | |||
| GET POST | /api/account/provider-keys | none | key | provider_key_save provider_keys_list | ||
| DELETE | /api/account/provider-keys/[id] | none | key | provider_key_remove | ||
| POST | /api/account/provider-keys/[id]/probe | none | key | provider_key_probe | ||
| GET | /api/account/provider-keys/[id]/probe-estimate | none | key | provider_key_probe_estimate | ||
| GET | /api/account/provider-keys/visibility | client-config:read | key | |||
| GET | /api/account/publisher-invoices | orders:read | key | account_publisher_invoices_list | ||
| POST | /api/account/publisher-invoices/[id]/mark-paid | orders:write | key | account_publisher_invoice_mark_paid | ||
| POST | /api/account/publisher-invoices/[id]/send-reminder | orders:write | key | |||
| GET | /api/account/reports | orders:read | key | |||
| GET | /api/account/summary | orders:read | key | |||
| GET | /api/account/usage | billing:read | key | usage_report | ||
| GET PUT | /api/account/usage-limits | billing:read billing:write | key | usage_limits_get usage_limits_update | ||
| GET | /api/account/usage-limits/approvals | billing:read | key | usage_approvals_list | ||
| POST | /api/account/usage-limits/approvals/[id] | billing:write | key | usage_approvals_decide | ||
| PUT DELETE | /api/account/usage-limits/features/[feature] | billing:write | key | usage_feature_cap_set | ||
| POST | /api/account/usage-limits/increase-requests | billing:write | key | usage_limit_increase_request | ||
| DELETE | /api/account/usage-limits/increase-requests/[id] | billing:write | key | usage_limit_increase_withdraw | ||
| GET | /api/account/usage/estimate | billing:read | 402 | receipt | key | usage_estimate |
| GET | /api/account/usage/jobs | billing:read | key | usage_jobs | ||
| GET | /api/account/usage/receipt | billing:read | key | usage_receipt | ||
| GET PUT | /api/account/user-mode | orders:read orders:write | key | |||
| GET | /api/account/volume-pricing | orders:read | key | |||
| GET PUT | /api/account/white-label | client-config:read client-config:write | key | |||
| POST PATCH DELETE | /api/account/white-label/domains | client-config:write | key | |||
| POST | /api/account/white-label/upload | client-config:write | key | |||
| POST | /api/account/workflows/[id]/orphan-resend | orders:write | key |
/api/accounts (5)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET DELETE | /api/accounts/[id] | client-config:read | key | |||
| GET | /api/accounts/[id]/clients | client-config:read | key | |||
| POST | /api/accounts/[id]/clients/[clientId]/subscription-offers | subscriptions:write | session only (scope) | |||
| GET | /api/accounts/[id]/collaborative-tags | none | session only | |||
| GET | /api/accounts/[id]/credits/balance | billing:read | key |
/api/admin (1)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET | /api/admin/credits/balance | billing:read | key | credits_balance |
/api/ai-find-sites (6)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| POST | /api/ai-find-sites | orders:write | key | |||
| GET | /api/ai-find-sites/[runId]/reconnect | orders:read | key | |||
| POST | /api/ai-find-sites/cancel | orders:write | key | |||
| GET | /api/ai-find-sites/cost-estimate | none | session only | |||
| POST | /api/ai-find-sites/create-order | none | session only | |||
| GET | /api/ai-find-sites/history | orders:read | key |
/api/analysis (13)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| POST | /api/analysis/bulk-backlinks | analysis:write | session only | |||
| GET | /api/analysis/clients | analysis:read | session only | |||
| GET POST | /api/analysis/competitors | analysis:read analysis:write | session only | |||
| GET | /api/analysis/competitors/[id] | analysis:read | session only | |||
| GET | /api/analysis/competitors/recent | analysis:read | session only | |||
| GET | /api/analysis/details/[analysisId] | analysis:read | session only | |||
| POST | /api/analysis/keyword-rankings | analysis:write | 402 | session only | ||
| GET | /api/analysis/off-page-intelligence/check-client | analysis:read | session only | |||
| POST | /api/analysis/off-page-intelligence/create | analysis:write | session only | |||
| GET | /api/analysis/off-page-intelligence/target-pages | analysis:read | session only | |||
| GET | /api/analysis/recent | analysis:read | session only | |||
| GET | /api/analysis/serp | analysis:read | session only | |||
| GET | /api/analysis/target-urls | analysis:read | session only |
/api/asset-bank (5)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET POST | /api/asset-bank | asset-bank:read asset-bank:write | key | asset_bank_create | ||
| GET PUT PATCH DELETE | /api/asset-bank/[id] | asset-bank:read asset-bank:write | key | asset_bank_delete asset_bank_get asset_bank_update | ||
| GET POST | /api/asset-bank/[id]/page-urls | asset-bank:read asset-bank:write | key | asset_bank_page_urls_add asset_bank_page_urls_list | ||
| PUT DELETE | /api/asset-bank/[id]/page-urls/[pageUrlId] | asset-bank:write | key | asset_bank_page_urls_delete asset_bank_page_urls_update | ||
| POST | /api/asset-bank/add-site | asset-bank:write | key | asset_bank_add_site |
/api/backlinks (4)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET POST | /api/backlinks/check-index | citation:read citation:write | key | |||
| GET POST | /api/backlinks/check-index/bulk | llm-tracking:write | key | citation_check_run_index_check | ||
| POST | /api/backlinks/check-index/bulk/stream | none | session only | |||
| GET | /api/backlinks/check-indexer-submission | citation:read | key |
/api/billing (3)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET | /api/billing/history | billing:read | key | billing_history | ||
| GET | /api/billing/receipt/[sessionId] | billing:read | key | |||
| GET | /api/billing/receipt/payment/[paymentId] | billing:read | key |
/api/bulk-analysis (2)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| POST | /api/bulk-analysis/enrich-domains | bulk-analysis:read | session only (scope) | |||
| GET POST | /api/bulk-analysis/projects | bulk-analysis:read | session only (scope) |
/api/clients (90)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET POST PUT DELETE | /api/clients | client-config:read client-config:write | key | |||
| GET PUT PATCH DELETE | /api/clients/[id] | client-config:read client-config:write | key | |||
| GET | /api/clients/[id]/activity | client-config:read | key | |||
| GET | /api/clients/[id]/anchor-overview | client-config:read | key | |||
| POST DELETE | /api/clients/[id]/archive | client-config:write | self-serve key | |||
| GET | /api/clients/[id]/backlinks/index-status | llm-tracking:read | key | citation_check_index_status | ||
| GET PUT | /api/clients/[id]/brand-aliases | client-config:read client-config:write | key | |||
| GET PATCH | /api/clients/[id]/brand-intelligence/brief | client-config:write orders:read | key | |||
| POST | /api/clients/[id]/brand-intelligence/cancel | orders:write | key | |||
| POST | /api/clients/[id]/brand-intelligence/generate-brief | orders:write | key | |||
| GET | /api/clients/[id]/brand-intelligence/latest | orders:read | key | |||
| POST | /api/clients/[id]/brand-intelligence/manual-brief | orders:write | key | |||
| POST | /api/clients/[id]/brand-intelligence/start-research | orders:write | key | |||
| GET | /api/clients/[id]/brand-intelligence/status | client-config:read | key | |||
| POST | /api/clients/[id]/brand-intelligence/submit-direct-answers | orders:write | key | |||
| POST | /api/clients/[id]/brand-intelligence/submit-input | orders:write | key | |||
| GET POST | /api/clients/[id]/bulk-analysis | orders:read orders:write | key | |||
| GET PUT DELETE | /api/clients/[id]/bulk-analysis/[domainId] | orders:write | key | |||
| POST | /api/clients/[id]/bulk-analysis/ai-qualify | orders:write | key | |||
| POST | /api/clients/[id]/bulk-analysis/analyze-dataforseo/check-cache | orders:read | key | |||
| PUT DELETE | /api/clients/[id]/bulk-analysis/bulk | orders:write | key | |||
| POST | /api/clients/[id]/bulk-analysis/check | orders:read | key | |||
| GET | /api/clients/[id]/bulk-analysis/dataforseo/check-analyzed | orders:read | key | |||
| GET | /api/clients/[id]/bulk-analysis/dataforseo/results | orders:read | key | |||
| GET | /api/clients/[id]/bulk-analysis/domains | orders:read | key | |||
| GET | /api/clients/[id]/bulk-analysis/export | orders:read | key | |||
| GET POST | /api/clients/[id]/bulk-analysis/master-qualify | orders:write | 402 | receipt | key | |
| PUT | /api/clients/[id]/bulk-analysis/move | orders:write | key | |||
| POST | /api/clients/[id]/bulk-analysis/prescreen-estimate | orders:write | 402 | receipt | key | |
| POST | /api/clients/[id]/bulk-analysis/refresh | orders:write | key | |||
| POST | /api/clients/[id]/bulk-analysis/target-match | orders:write | key | |||
| GET POST PUT PATCH DELETE | /api/clients/[id]/content-strategy | client-config:write orders:read | key | |||
| GET | /api/clients/[id]/content-strategy/distribution | orders:read | key | |||
| GET | /api/clients/[id]/content-strategy/keywords | orders:read | key | |||
| GET | /api/clients/[id]/domains-in-orders | orders:read | key | |||
| GET POST DELETE | /api/clients/[id]/excluded-domains | client-config:read client-config:write | key | |||
| POST | /api/clients/[id]/excluded-domains/import-dataforseo | orders:write | key | |||
| GET PUT | /api/clients/[id]/fact-check-instructions | client-config:read client-config:write | key | client_fact_check_instructions_get client_fact_check_instructions_update | ||
| POST | /api/clients/[id]/import-backlinks/bulk | orders:write | key | |||
| GET PUT | /api/clients/[id]/li-preferences | client-config:read client-config:write | key | |||
| GET | /api/clients/[id]/llm-tracking/backlinks | llm-tracking:read | key | client_llm_backlinks | ||
| GET | /api/clients/[id]/llm-tracking/backlinks/[lineItemId]/history | llm-tracking:read | key | client_llm_backlink_history | ||
| GET POST DELETE | /api/clients/[id]/llm-tracking/backlinks/[lineItemId]/keywords | llm-tracking:read llm-tracking:write | key | client_llm_backlink_keyword_add client_llm_backlink_keyword_delete client_llm_backlink_keywords_list | ||
| POST | /api/clients/[id]/llm-tracking/backlinks/delete | llm-tracking:write | key | client_llm_backlink_delete | ||
| POST | /api/clients/[id]/llm-tracking/backlinks/extract-keywords | llm-tracking:write | 402 | receipt | key | client_llm_backlink_extract_keywords |
| POST | /api/clients/[id]/llm-tracking/backlinks/tags | llm-tracking:write | key | client_llm_backlink_tags_set | ||
| GET POST | /api/clients/[id]/llm-tracking/check | llm-tracking:read llm-tracking:write | 402 | key | client_llm_check_cost_estimate | |
| POST | /api/clients/[id]/llm-tracking/check-async | llm-tracking:write | 402 | receipt | key | client_llm_check_async |
| GET | /api/clients/[id]/llm-tracking/check-history | llm-tracking:read | key | client_llm_check_history | ||
| GET PUT | /api/clients/[id]/llm-tracking/check-settings | llm-tracking:read llm-tracking:write | key | client_llm_check_settings_get client_llm_check_settings_set | ||
| GET | /api/clients/[id]/llm-tracking/check-status | llm-tracking:read | key | client_llm_check_status | ||
| GET | /api/clients/[id]/llm-tracking/comparison | llm-tracking:read | key | client_llm_comparison | ||
| GET | /api/clients/[id]/llm-tracking/export | llm-tracking:read | key | client_llm_export | ||
| GET POST | /api/clients/[id]/llm-tracking/extract-keywords | llm-tracking:read llm-tracking:write | 402 | receipt | key | client_llm_extract_keywords client_llm_extract_keywords_status |
| GET POST | /api/clients/[id]/llm-tracking/import | llm-tracking:read llm-tracking:write | key | client_llm_import client_llm_import_list | ||
| GET | /api/clients/[id]/llm-tracking/import/[batchId]/status | llm-tracking:read | key | client_llm_import_status | ||
| POST | /api/clients/[id]/llm-tracking/keyword-cloud-batch | llm-tracking:write | 402 | receipt | key | client_llm_keyword_cloud_batch |
| GET | /api/clients/[id]/llm-tracking/keyword-groups | llm-tracking:read | key | client_llm_keyword_groups_list | ||
| POST | /api/clients/[id]/llm-tracking/keyword-groups/set | llm-tracking:write | key | client_llm_keyword_groups_set | ||
| GET PUT | /api/clients/[id]/llm-tracking/keyword-locations | llm-tracking:read llm-tracking:write | key | client_llm_keyword_locations | ||
| GET POST | /api/clients/[id]/llm-tracking/keywords | llm-tracking:read llm-tracking:write | key | client_llm_keywords | ||
| GET | /api/clients/[id]/llm-tracking/keywords/[keyword]/history | llm-tracking:read | key | client_llm_keyword_history | ||
| POST | /api/clients/[id]/llm-tracking/keywords/bulk-add | llm-tracking:write | key | client_llm_keywords_bulk_add | ||
| GET | /api/clients/[id]/llm-tracking/keywords/suggest-backlinks | llm-tracking:read | key | client_llm_keyword_suggest_backlinks | ||
| GET | /api/clients/[id]/llm-tracking/mentions | llm-tracking:read | key | client_llm_mentions | ||
| GET POST | /api/clients/[id]/llm-tracking/saved-searches | llm-tracking:read llm-tracking:write | key | client_llm_saved_search_create client_llm_saved_searches_list | ||
| PATCH DELETE | /api/clients/[id]/llm-tracking/saved-searches/[searchId] | llm-tracking:write | key | client_llm_saved_search_delete client_llm_saved_search_update | ||
| GET POST | /api/clients/[id]/llm-tracking/share | llm-tracking:read llm-tracking:write | key | client_llm_share_create client_llm_share_list | ||
| DELETE | /api/clients/[id]/llm-tracking/share/[linkId] | llm-tracking:write | key | client_llm_share_delete | ||
| GET | /api/clients/[id]/llm-tracking/stats | llm-tracking:read | key | client_llm_stats | ||
| GET PUT | /api/clients/[id]/market-context | client-config:read client-config:write | key | client_market_context_get client_market_context_update | ||
| GET POST | /api/clients/[id]/market-context/generate | orders:write | 402 | receipt | key | |
| GET PUT | /api/clients/[id]/metrics-criteria | client-config:read client-config:write | key | |||
| GET PUT | /api/clients/[id]/outline-preferences | client-config:read client-config:write | key | client_outline_preferences_get client_outline_preferences_update | ||
| GET PUT | /api/clients/[id]/page-type-rules | client-config:read client-config:write | key | |||
| GET | /api/clients/[id]/plan-alignment | client-config:read | key | |||
| GET POST | /api/clients/[id]/plans | client-config:read client-config:write | key | |||
| GET PATCH DELETE | /api/clients/[id]/plans/[planId] | client-config:write orders:read | key | |||
| GET POST | /api/clients/[id]/plans/[planId]/share | orders:write | key | |||
| DELETE | /api/clients/[id]/plans/[planId]/share/[linkId] | orders:write | key | |||
| GET POST | /api/clients/[id]/projects | client-config:read client-config:write | key | |||
| GET PATCH DELETE | /api/clients/[id]/projects/[projectId] | orders:write | key | |||
| GET | /api/clients/[id]/report-links | client-config:read | key | |||
| GET | /api/clients/[id]/stats | client-config:read | key | |||
| GET | /api/clients/[id]/target-page-activity | orders:read | key | |||
| GET POST PUT PATCH DELETE | /api/clients/[id]/target-pages | client-config:read client-config:write orders:write | key | |||
| GET POST | /api/clients/[id]/tier2-candidates | client-config:read client-config:write | key | |||
| GET POST | /api/clients/[id]/topic-bank | llm-tracking:read llm-tracking:write | key | topic_bank_create topic_bank_get | ||
| PATCH | /api/clients/[id]/topic-bank/[keywordId] | llm-tracking:write | key | topic_bank_update | ||
| GET | /api/clients/[id]/workflows | workflows:read | key |
/api/configuration (1)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET | /api/configuration/service-fee | none | session only |
/api/credits (2)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET | /api/credits/balance | billing:read | key | credits_balance | ||
| POST | /api/credits/purchase-session | credits:purchase | key | credits_create_purchase_session |
/api/domains (1)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET | /api/domains/available | bulk-analysis:read | session only (scope) |
/api/exchange-approval-batches (1)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| POST | /api/exchange-approval-batches/[id]/send-replies | opportunities:write | key | exchange_reply_batch_send |
/api/exchanges (6)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET PATCH | /api/exchanges/[id] | opportunities:read opportunities:write | key | exchange_get | ||
| GET POST | /api/exchanges/[id]/conversations | opportunities:read opportunities:write | key | exchange_get | ||
| POST | /api/exchanges/[id]/participants/[participantId]/accept | opportunities:read | key | |||
| POST | /api/exchanges/[id]/participants/[participantId]/decline | opportunities:read | key | |||
| GET | /api/exchanges/opportunity-pages | opportunities:read | key | opportunity_page_list | ||
| GET PUT | /api/exchanges/opportunity-pages/[id] | opportunities:read opportunities:write | key | opportunity_page_get opportunity_page_update |
/api/google (1)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| POST | /api/google/create-doc | workflows:write | key |
/api/internal/accounts (1)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET | /api/internal/accounts/[accountId]/billing-summary | billing:read | key | account_billing_summary |
/api/internal/ai-find-sites (5)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| POST | /api/internal/ai-find-sites/cancel | orders:write | self-serve key | ai_find_sites_cancel | ||
| POST | /api/internal/ai-find-sites/create-order | orders:write | self-serve key | ai_find_sites_create_order | ||
| GET | /api/internal/ai-find-sites/history | orders:read | self-serve key | ai_find_sites_history | ||
| POST | /api/internal/ai-find-sites/start | orders:write | self-serve key | ai_find_sites_start | ||
| GET | /api/internal/ai-find-sites/status | orders:read | self-serve key | ai_find_sites_status |
/api/internal/article-gen (9)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| POST | /api/internal/article-gen/anchor-apply | article-gen:write | self-serve key | article_gen_anchor_apply | ||
| POST | /api/internal/article-gen/anchor-dismiss | article-gen:write | self-serve key | article_gen_anchor_dismiss | ||
| GET POST | /api/internal/article-gen/anchor-generate | article-gen:read article-gen:write | 402 | receipt | self-serve key | article_gen_anchor_generate |
| GET | /api/internal/article-gen/anchor-suggestions | article-gen:read | self-serve key | article_gen_anchor_suggestions | ||
| POST | /api/internal/article-gen/batch-start | article-gen:write | self-serve key | article_gen_batch_start | ||
| GET | /api/internal/article-gen/readiness | article-gen:read | self-serve key | article_gen_readiness | ||
| POST | /api/internal/article-gen/set-anchor-text | article-gen:write | self-serve key | article_gen_set_anchor_text | ||
| POST | /api/internal/article-gen/start | article-gen:write | 402 | receipt | self-serve key | article_gen_start |
| GET | /api/internal/article-gen/status | article-gen:read | self-serve key | article_gen_status |
/api/internal/backlink-cases (1)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET POST | /api/internal/backlink-cases | publishers:read publishers:write | session only (scope) |
/api/internal/bulk-analysis (2)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| POST | /api/internal/bulk-analysis/add-domains | bulk-analysis:write | self-serve key | bulk_analysis_add_domains | ||
| POST | /api/internal/bulk-analysis/requalify | bulk-analysis:write | 402 | receipt | self-serve key | bulk_analysis_requalify |
/api/internal/change-requests (1)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET POST | /api/internal/change-requests | orders:read orders:write | self-serve key |
/api/internal/client-config (3)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET | /api/internal/client-config/readiness | client-config:read | key | client_config_readiness | ||
| GET PATCH | /api/internal/client-config/target-pages | client-config:read client-config:write | self-serve key | client_config_target_pages target_pages_update_url | ||
| POST | /api/internal/client-config/update | client-config:write | self-serve key | client_config_update |
/api/internal/clients (38)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET POST | /api/internal/clients/[id]/analysis | client-config:read client-config:write | key | client_analysis_list client_analysis_publish | ||
| PATCH DELETE | /api/internal/clients/[id]/analysis/[entryId] | client-config:write | key | client_analysis_delete client_analysis_update | ||
| POST | /api/internal/clients/[id]/analysis/upload | client-config:write | key | |||
| POST | /api/internal/clients/[id]/backfill-historical-citations | llm-tracking:write | key | |||
| GET PUT | /api/internal/clients/[id]/brand-aliases | client-config:read client-config:write | self-serve key | client_brand_aliases_get client_brand_aliases_set | ||
| GET | /api/internal/clients/[id]/campaign-history | topic-gen:read | key | client_campaign_history | ||
| GET | /api/internal/clients/[id]/citation-pipeline | llm-tracking:read | key | citation_pipeline_status | ||
| POST | /api/internal/clients/[id]/citation-prep | llm-tracking:write | key | citation_prep | ||
| GET PATCH | /api/internal/clients/[id]/content-strategy | client-config:read client-config:write | key | |||
| GET | /api/internal/clients/[id]/exchange-inventory | asset-bank:read | key | client_exchange_inventory_summary | ||
| GET | /api/internal/clients/[id]/exchange-readiness | asset-bank:read | key | |||
| GET POST DELETE | /api/internal/clients/[id]/excluded-domains | client-config:read client-config:write orders:write | self-serve key | client_excluded_domains_add client_excluded_domains_list | ||
| POST | /api/internal/clients/[id]/excluded-domains/import-dataforseo | orders:write | 402 | receipt | key | client_excluded_domains_auto_import |
| GET | /api/internal/clients/[id]/link-plan-check-in | crm:read | key | link_plan_check_in | ||
| GET | /api/internal/clients/[id]/link-plan-suggest | crm:read | key | link_plan_suggest | ||
| GET | /api/internal/clients/[id]/llm-tracking/check-status | llm-tracking:read | key | citation_check_status | ||
| POST | /api/internal/clients/[id]/llm-tracking/curate-keywords | llm-tracking:write | key | citation_check_curate_keywords | ||
| POST | /api/internal/clients/[id]/llm-tracking/extract-keywords | llm-tracking:write | 402 | receipt | key | citation_check_extract_keywords |
| GET | /api/internal/clients/[id]/llm-tracking/readiness | llm-tracking:read | key | citation_check_readiness | ||
| POST | /api/internal/clients/[id]/llm-tracking/reset-keywords | llm-tracking:write | key | citation_check_reset_keywords | ||
| GET | /api/internal/clients/[id]/llm-tracking/results | llm-tracking:read | key | citation_check_results | ||
| POST | /api/internal/clients/[id]/llm-tracking/run-checks | llm-tracking:write | key | citation_check_trigger | ||
| GET POST | /api/internal/clients/[id]/plans | crm:read crm:write | key | link_plan_create link_plan_get | ||
| GET PATCH DELETE | /api/internal/clients/[id]/plans/[planId] | crm:read crm:write | key | link_plan_activate link_plan_update | ||
| GET POST | /api/internal/clients/[id]/report-contacts | client-config:read client-config:write | key | client_report_contact_add | ||
| PATCH DELETE | /api/internal/clients/[id]/report-contacts/[contactId] | client-config:write | key | |||
| GET | /api/internal/clients/[id]/report-highlights | orders:read | key | client_report_highlights | ||
| GET POST | /api/internal/clients/[id]/report-messages | client-config:read client-config:write | key | client_report_message_create client_report_messages_list | ||
| PATCH DELETE | /api/internal/clients/[id]/report-messages/[messageId] | client-config:write | key | client_report_message_delete client_report_message_send | ||
| GET | /api/internal/clients/[id]/report-sends | client-config:read | key | |||
| GET POST PATCH DELETE | /api/internal/clients/[id]/report-token | client-config:read client-config:write | key | |||
| GET PATCH | /api/internal/clients/[id]/site-approval-batches | orders:read orders:write | key | site_approval_batch_add_items site_approval_batch_list site_approval_batch_remove_items | ||
| GET | /api/internal/clients/[id]/target-page-coverage | client-config:read | key | client_target_page_coverage | ||
| GET | /api/internal/clients/[id]/target-pages | client-config:read | key | |||
| POST | /api/internal/clients/[id]/topic-bank/import | llm-tracking:write | key | topic_bank_import | ||
| POST | /api/internal/clients/create | client-config:write | key | client_create | ||
| GET | /api/internal/clients/report-highlights-batch | orders:read | key | client_report_highlights_batch | ||
| POST | /api/internal/clients/search | orders:read | key | client_search |
/api/internal/collaborative-placements (2)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET | /api/internal/collaborative-placements/opportunities | collaborative-placements:read | key | collab_opportunities | ||
| GET | /api/internal/collaborative-placements/order-summary | collaborative-placements:read | key | collab_order_summary |
/api/internal/dataforseo (1)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET | /api/internal/dataforseo/site-metrics | websites:read | 402 | receipt | key | dataforseo_site_metrics |
/api/internal/line-items (8)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| POST | /api/internal/line-items/assign-domain | line-items:write | self-serve key | line_items_assign_domain | ||
| POST | /api/internal/line-items/batch-update | line-items:write | self-serve key | line_items_batch_update | ||
| POST | /api/internal/line-items/conversations-batch | line-items:read | key | line_items_conversations_batch | ||
| GET | /api/internal/line-items/keyword-data | line-items:read | key | line_items_keyword_data | ||
| GET | /api/internal/line-items/list | line-items:read | key | line_items_list | ||
| GET | /api/internal/line-items/operations | line-items:read | key | line_items_operations | ||
| GET | /api/internal/line-items/qualification | line-items:read | key | line_items_qualification | ||
| POST | /api/internal/line-items/update | line-items:write | self-serve key | line_items_update |
/api/internal/opportunity-intel (3)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET POST | /api/internal/opportunity-intel/osg-enqueue | opportunities:read opportunities:write | key | opportunity_osg_enqueue | ||
| POST | /api/internal/opportunity-intel/osg-pipeline | opportunities:write | 402 | receipt | key | opportunity_osg_run |
| GET POST | /api/internal/opportunity-intel/pin-to-token | opportunities:read opportunities:write | key | opportunity_osg_pin |
/api/internal/orders (9)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| POST | /api/internal/orders/[orderId]/assign-from-project | orders:write | self-serve key | ai_find_sites_assign_to_items | ||
| GET | /api/internal/orders/[orderId]/get | orders:read | key | order_get | ||
| POST | /api/internal/orders/[orderId]/refresh-metadata | orders:write | self-serve key | order_refresh_pricing | ||
| POST | /api/internal/orders/[orderId]/submit | orders:write | self-serve key | order_submit | ||
| POST | /api/internal/orders/add-line-items | line-items:write | self-serve key | line_items_add_to_order | ||
| GET | /api/internal/orders/article-status | orders:read | key | order_article_status | ||
| POST PATCH | /api/internal/orders/byoc | orders:write | key | order_byoc_update order_byoc_upload | ||
| POST | /api/internal/orders/create | orders:write | self-serve key | order_create | ||
| GET | /api/internal/orders/list | orders:read | key | order_list |
/api/internal/outreach-agent (1)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET | /api/internal/outreach-agent/keyword-presets | outreach:read | session only (scope) |
/api/internal/replacement-status (1)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET | /api/internal/replacement-status | orders:read | key | replacement_status |
/api/internal/search-queries (6)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET | /api/internal/search-queries | search-queries:read | key | search_queries_list | ||
| GET DELETE | /api/internal/search-queries/batches | search-queries:read search-queries:write | self-serve key | search_queries_batches search_queries_delete_batch | ||
| POST | /api/internal/search-queries/import | search-queries:write | self-serve key | search_queries_import | ||
| POST | /api/internal/search-queries/import-csv | search-queries:write | self-serve key | search_queries_import_csv | ||
| POST | /api/internal/search-queries/regenerate-brief | search-queries:write | 402 | receipt | self-serve key | search_queries_regenerate_brief |
| GET | /api/internal/search-queries/summary | search-queries:read | key | search_queries_summary |
/api/internal/site-approvals (1)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET POST PATCH | /api/internal/site-approvals | orders:read orders:write | key |
/api/internal/target-pages (5)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| POST | /api/internal/target-pages/add | client-config:write | self-serve key | target_pages_add | ||
| GET POST | /api/internal/target-pages/anchor-plan | article-gen:read article-gen:write | self-serve key | anchor_plan_get anchor_plan_update | ||
| POST | /api/internal/target-pages/bulk-generate | orders:write | self-serve key | target_pages_bulk_generate | ||
| POST | /api/internal/target-pages/fetch-backlinks | orders:write | 402 | receipt | self-serve key | target_page_fetch_backlinks |
| POST | /api/internal/target-pages/update-status | client-config:write | self-serve key | target_pages_update_status |
/api/internal/topic-gen (11)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| POST | /api/internal/topic-gen/finalize-keyword | topic-gen:write | self-serve key | topic_gen_finalize_keyword | ||
| GET | /api/internal/topic-gen/order-status | topic-gen:read | self-serve key | topic_gen_order_status | ||
| GET | /api/internal/topic-gen/pending-keywords | topic-gen:read | self-serve key | topic_gen_pending_keywords | ||
| GET | /api/internal/topic-gen/phase23-scores | topic-gen:read | self-serve key | topic_gen_phase23_scores | ||
| POST | /api/internal/topic-gen/phase4-start | topic-gen:write | self-serve key | topic_gen_start_phase4 | ||
| GET | /api/internal/topic-gen/phase4-titles | topic-gen:read | self-serve key | topic_gen_phase4_titles | ||
| POST | /api/internal/topic-gen/reset-session | topic-gen:write | self-serve key | topic_gen_reset_session | ||
| POST | /api/internal/topic-gen/start | topic-gen:write | 402 | receipt | self-serve key | topic_gen_start |
| POST | /api/internal/topic-gen/submit-title | topic-gen:write | self-serve key | topic_gen_submit_title | ||
| GET | /api/internal/topic-gen/target-urls | topic-gen:read | self-serve key | topic_gen_target_urls | ||
| GET POST | /api/internal/topic-gen/title-approval | topic-gen:read topic-gen:write | self-serve key | topic_gen_title_approval_status |
/api/internal/websites (2)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET | /api/internal/websites/pages | websites:read | self-serve key | website_pages_query | ||
| POST | /api/internal/websites/search | websites:read | self-serve key | website_search |
/api/internal/whitelabel-report-docs (1)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| POST | /api/internal/whitelabel-report-docs | client-config:write | key |
/api/internal/workflows (8)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| POST | /api/internal/workflows/create | workflows:write | self-serve key | workflow_create | ||
| POST | /api/internal/workflows/export-doc | workflows:write | self-serve key | workflow_export_doc | ||
| POST | /api/internal/workflows/generate-brief | workflows:write | self-serve key | workflow_generate_brief | ||
| POST | /api/internal/workflows/generate-contextual | workflows:write | self-serve key | workflow_generate_contextual | ||
| POST | /api/internal/workflows/generate-listicle | workflows:write | self-serve key | workflow_generate_listicle | ||
| GET | /api/internal/workflows/read | workflows:read | key | workflow_read | ||
| POST | /api/internal/workflows/verify-doc | workflows:write | self-serve key | workflow_verify_doc | ||
| POST | /api/internal/workflows/verify-publication | workflows:write | self-serve key | workflow_verify_publication |
/api/line-items (4)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET | /api/line-items/[id] | none | session only | |||
| GET POST | /api/line-items/[id]/conversation | orders:read orders:write | key | line_item_conversation_read line_item_message_publisher | ||
| GET | /api/line-items/[id]/enrich | none | session only | |||
| GET | /api/line-items/[id]/invoice | orders:read | key | line_item_invoice_get |
/api/llm-pricing (1)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET POST | /api/llm-pricing | none | session only |
/api/notifications (1)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET | /api/notifications/summary | orders:read | key |
/api/opportunities (21)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET POST | /api/opportunities | opportunities:read | key | opportunity_list opportunity_submissions_list | ||
| GET PUT DELETE | /api/opportunities/[id] | opportunities:read opportunities:write | key | opportunity_get opportunity_update | ||
| POST | /api/opportunities/[id]/accept-collab | opportunities:write | key | opportunity_accept_collab | ||
| POST | /api/opportunities/[id]/accept-exchange | opportunities:write | key | opportunity_accept_exchange | ||
| GET | /api/opportunities/[id]/cadence/audit | opportunities:read | key | exchange_cadence_audit | ||
| GET POST DELETE | /api/opportunities/[id]/candidate-preferences | opportunities:read opportunities:write | key | |||
| POST | /api/opportunities/[id]/candidate-preferences/promote | orders:write | key | |||
| GET POST | /api/opportunities/[id]/conversation | opportunities:read opportunities:write | key | opportunity_conversation_post opportunity_conversation_read | ||
| POST | /api/opportunities/[id]/decline | opportunities:write | key | opportunity_decline | ||
| GET POST | /api/opportunities/[id]/discovery-candidates | opportunities:read opportunities:write | key | opportunity_candidate_add opportunity_candidate_list | ||
| PATCH DELETE | /api/opportunities/[id]/discovery-candidates/[key] | opportunities:write | key | opportunity_candidate_delete opportunity_candidate_update | ||
| POST | /api/opportunities/[id]/discovery-candidates/[key]/feeler | opportunities:write | key | opportunity_feeler_send | ||
| POST | /api/opportunities/[id]/discovery-candidates/scan | opportunities:read opportunities:write | key | opportunity_candidate_scan | ||
| GET | /api/opportunities/[id]/lifecycle | opportunities:read | key | opportunity_lifecycle | ||
| GET | /api/opportunities/[id]/replies | opportunities:read | key | opportunity_get | ||
| GET | /api/opportunities/[id]/reply/draft | opportunities:read | key | exchange_reply_draft exchange_reply_send | ||
| POST | /api/opportunities/[id]/reply/prep | opportunities:write | key | exchange_reply_prep | ||
| POST | /api/opportunities/[id]/reply/send | opportunities:write | key | exchange_reply_send | ||
| GET | /api/opportunities/[id]/thread-text | opportunities:read | key | |||
| GET | /api/opportunities/[id]/token-status | opportunities:read | key | opportunity_token_status | ||
| GET | /api/opportunities/batches | opportunities:read | key | opportunity_batch_summary |
/api/opportunity-intel (8)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| POST | /api/opportunity-intel/auto-pick-anchor | opportunities:write | key | |||
| POST | /api/opportunity-intel/candidate-pages | opportunities:write | key | opportunity_picker_run | ||
| POST | /api/opportunity-intel/record-anchor | opportunities:write | key | opportunity_picker_record_anchor | ||
| POST | /api/opportunity-intel/record-insertion-url | opportunities:write | key | |||
| POST | /api/opportunity-intel/record-opportunity-pick | opportunities:write | key | |||
| POST | /api/opportunity-intel/record-pick | opportunities:write | key | opportunity_picker_record_pick | ||
| POST | /api/opportunity-intel/record-target-page | opportunities:write | key | |||
| GET | /api/opportunity-intel/run-history | opportunities:read | key | opportunity_picker_history |
/api/order-line-items (1)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET PATCH | /api/order-line-items/[lineItemId] | line-items:read line-items:write | key |
/api/orders (51)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET POST | /api/orders | orders:read orders:write | key | |||
| GET PUT DELETE | /api/orders/[id] | orders:read orders:write | key | |||
| POST | /api/orders/[id]/add-domains | orders:write | key | |||
| GET POST | /api/orders/[id]/benchmark | orders:read | key | |||
| GET | /api/orders/[id]/bulk-import-batches | orders:read | key | |||
| DELETE | /api/orders/[id]/bulk-import-batches/[batchId] | orders:write | key | |||
| GET | /api/orders/[id]/bulk-import-template.csv | orders:read | key | |||
| POST PATCH | /api/orders/[id]/byoc | orders:write | key | |||
| GET POST | /api/orders/[id]/conversation | orders:read orders:write | key | |||
| POST | /api/orders/[id]/create-checkout-session | orders:write | key | |||
| POST | /api/orders/[id]/create-workflow | workflows:write | key | workflow_create_for_line_item | ||
| POST | /api/orders/[id]/generate-workflows | orders:write | key | |||
| POST | /api/orders/[id]/inline-analyze | orders:write | 402 | receipt | key | |
| POST | /api/orders/[id]/invoice | orders:write | key | order_generate_invoice | ||
| GET | /api/orders/[id]/invoice/download | orders:read | key | |||
| GET POST PATCH DELETE | /api/orders/[id]/line-items | orders:read orders:write | key | |||
| GET PATCH DELETE | /api/orders/[id]/line-items/[lineItemId] | orders:read orders:write | key | |||
| GET POST | /api/orders/[id]/line-items/assign-domains | none | session only | |||
| GET | /api/orders/[id]/line-items/available-domains | orders:read | key | |||
| POST | /api/orders/[id]/line-items/bulk-commit | orders:write | key | |||
| GET | /api/orders/[id]/line-items/enrich | line-items:read | key | line_items_enrich | ||
| POST | /api/orders/[id]/line-items/preview | orders:write | key | |||
| GET | /api/orders/[id]/line-items/unread-replies | line-items:read | key | |||
| POST | /api/orders/[id]/mark-complete | orders:write | key | |||
| GET | /api/orders/[id]/payment-events | orders:read | key | |||
| GET | /api/orders/[id]/plan-alignment | orders:read | key | |||
| POST | /api/orders/[id]/prepare-bulk-analysis | orders:write | key | |||
| POST | /api/orders/[id]/prescreen-estimate | orders:write | 402 | receipt | key | |
| GET POST | /api/orders/[id]/refund | none | session only | |||
| GET | /api/orders/[id]/replacement-orders | orders:read | key | |||
| GET POST | /api/orders/[id]/request-more-sites | orders:read orders:write | key | |||
| POST | /api/orders/[id]/resubmit | orders:write | key | |||
| POST | /api/orders/[id]/status-transition | orders:write | session only | |||
| GET POST DELETE | /api/orders/[id]/strategy | orders:read | key | |||
| POST | /api/orders/[id]/submit | orders:write | key | |||
| GET | /api/orders/[id]/suggestions | orders:read | key | |||
| POST | /api/orders/[id]/sync-bulk-analysis | orders:write | key | |||
| GET | /api/orders/[id]/topic-generation/preflight | orders:read | key | |||
| POST | /api/orders/[id]/topic-generation/start | orders:write | 402 | receipt | key | |
| GET | /api/orders/[id]/topic-generation/status | orders:read | key | |||
| POST | /api/orders/[id]/verify-payment-session | orders:read | key | |||
| GET | /api/orders/available-for-domains | none | session only | |||
| POST | /api/orders/bulk-update-delivery-month | orders:write | key | |||
| POST | /api/orders/calculate-pricing | orders:read | key | |||
| POST | /api/orders/copy-from-preferences | orders:write | key | |||
| GET POST | /api/orders/drafts | orders:read orders:write | key | |||
| GET PUT DELETE | /api/orders/drafts/[id] | orders:read orders:write | key | |||
| POST | /api/orders/line-items/[id]/lock | orders:write | key | |||
| GET | /api/orders/open | orders:read | key | |||
| POST | /api/orders/payment-preview | orders:read | key | |||
| POST | /api/orders/quick-create | orders:write | key |
/api/prospectfinder (65)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET POST | /api/prospectfinder/campaigns | none | session only | |||
| GET PATCH | /api/prospectfinder/campaigns/[id] | none | session only | |||
| GET POST | /api/prospectfinder/campaigns/[id]/agency-clients/bulk | none | session only | |||
| GET | /api/prospectfinder/campaigns/[id]/available-fields | none | session only | |||
| GET PATCH DELETE | /api/prospectfinder/campaigns/[id]/backlinks | none | session only | |||
| POST | /api/prospectfinder/campaigns/[id]/backlinks/apply-filters | none | session only | |||
| GET | /api/prospectfinder/campaigns/[id]/backlinks/fetch-status/[applicationId] | none | session only | |||
| POST | /api/prospectfinder/campaigns/[id]/backlinks/push-to-bulk-analysis | none | session only | |||
| GET | /api/prospectfinder/campaigns/[id]/backlinks/qualification-history | none | session only | |||
| GET | /api/prospectfinder/campaigns/[id]/backlinks/qualification-stats | none | session only | |||
| GET | /api/prospectfinder/campaigns/[id]/backlinks/qualification-status/[applicationId] | none | session only | |||
| GET | /api/prospectfinder/campaigns/[id]/botdog-export-history | none | session only | |||
| GET | /api/prospectfinder/campaigns/[id]/botdog-stats | none | session only | |||
| GET POST | /api/prospectfinder/campaigns/[id]/campaign-types | none | session only | |||
| PATCH | /api/prospectfinder/campaigns/[id]/campaign-types/[typeId] | none | session only | |||
| GET POST | /api/prospectfinder/campaigns/[id]/citation-check | none | session only | |||
| GET POST DELETE | /api/prospectfinder/campaigns/[id]/classify | none | session only | |||
| GET | /api/prospectfinder/campaigns/[id]/classify/active-run | none | session only | |||
| GET POST PATCH DELETE | /api/prospectfinder/campaigns/[id]/competitors | none | session only | |||
| GET POST | /api/prospectfinder/campaigns/[id]/compose | none | session only | |||
| GET POST DELETE | /api/prospectfinder/campaigns/[id]/contacts | none | session only | |||
| GET | /api/prospectfinder/campaigns/[id]/domain-enrichment | none | session only | |||
| GET POST | /api/prospectfinder/campaigns/[id]/enhancements | none | session only | |||
| POST | /api/prospectfinder/campaigns/[id]/enhancements/config | none | session only | |||
| GET PATCH | /api/prospectfinder/campaigns/[id]/enhancements/rejections | none | session only | |||
| POST | /api/prospectfinder/campaigns/[id]/enhancements/rerun-assignments | none | session only | |||
| POST | /api/prospectfinder/campaigns/[id]/export-csv | none | session only | |||
| GET | /api/prospectfinder/campaigns/[id]/export-history | none | session only | |||
| POST | /api/prospectfinder/campaigns/[id]/import-apollo-csv | none | session only | |||
| POST | /api/prospectfinder/campaigns/[id]/import-backlink-domains | none | session only | |||
| POST | /api/prospectfinder/campaigns/[id]/import-domains | none | session only | |||
| GET POST | /api/prospectfinder/campaigns/[id]/inventory-matches | none | session only | |||
| GET | /api/prospectfinder/campaigns/[id]/keyword-history | none | session only | |||
| GET | /api/prospectfinder/campaigns/[id]/keyword-pool/active-run | none | session only | |||
| POST | /api/prospectfinder/campaigns/[id]/keyword-pool/pull | none | session only | |||
| GET | /api/prospectfinder/campaigns/[id]/keyword-pool/recent-runs | none | session only | |||
| GET | /api/prospectfinder/campaigns/[id]/keyword-pool/rows | none | session only | |||
| GET | /api/prospectfinder/campaigns/[id]/keyword-pool/summary | none | session only | |||
| GET POST | /api/prospectfinder/campaigns/[id]/keyword-search | none | session only | |||
| GET PATCH DELETE | /api/prospectfinder/campaigns/[id]/keyword-search/[searchId] | none | session only | |||
| GET | /api/prospectfinder/campaigns/[id]/keyword-seeds | none | session only | |||
| PATCH | /api/prospectfinder/campaigns/[id]/keyword-seeds/[seedId] | none | session only | |||
| GET | /api/prospectfinder/campaigns/[id]/metrics/active-run | none | session only | |||
| GET POST | /api/prospectfinder/campaigns/[id]/metrics/presets | none | session only | |||
| GET POST PUT | /api/prospectfinder/campaigns/[id]/metrics/recipes | none | session only | |||
| GET | /api/prospectfinder/campaigns/[id]/outreach/drafts | none | session only | |||
| PATCH | /api/prospectfinder/campaigns/[id]/outreach/drafts/[draftId] | none | session only | |||
| POST | /api/prospectfinder/campaigns/[id]/outreach/drafts/[draftId]/re-polish | none | session only | |||
| PATCH | /api/prospectfinder/campaigns/[id]/outreach/drafts/bulk | none | session only | |||
| PATCH | /api/prospectfinder/campaigns/[id]/outreach/drafts/bulk-replace | none | session only | |||
| GET | /api/prospectfinder/campaigns/[id]/outreach/eligible-contacts | none | session only | |||
| POST | /api/prospectfinder/campaigns/[id]/outreach/generate-drafts | none | session only | |||
| GET | /api/prospectfinder/campaigns/[id]/outreach/polish-status | none | session only | |||
| GET | /api/prospectfinder/campaigns/[id]/outreach/rounds | none | session only | |||
| GET | /api/prospectfinder/campaigns/[id]/outreach/rounds/active | none | session only | |||
| GET PATCH | /api/prospectfinder/campaigns/[id]/prospect-domains | none | session only | |||
| POST | /api/prospectfinder/campaigns/[id]/push-to-botdog | none | session only | |||
| POST | /api/prospectfinder/campaigns/[id]/push-to-botdog-batch | none | session only | |||
| POST | /api/prospectfinder/campaigns/[id]/push-to-botdog-stream | none | session only | |||
| POST | /api/prospectfinder/campaigns/[id]/push-to-manyreach | none | session only | |||
| GET POST DELETE | /api/prospectfinder/campaigns/[id]/qualify-domains | none | session only | |||
| POST | /api/prospectfinder/campaigns/[id]/rerun-qualification | none | session only | |||
| POST | /api/prospectfinder/campaigns/[id]/verify-contacts | none | session only | |||
| GET | /api/prospectfinder/campaigns/[id]/verify-contacts/estimate | none | session only | |||
| POST | /api/prospectfinder/keyword-search/check-duplicates | none | session only |
/api/publisher (1)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET | /api/publisher/orders/[lineItemId]/status-history | none | session only |
/api/publisher-offerings (1)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET | /api/publisher-offerings | publishers:read | session only (scope) |
/api/subscriptions (8)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| POST DELETE | /api/subscriptions/cancel | orders:write | key | subscription_cancel | ||
| POST | /api/subscriptions/change-plan | orders:write | key | |||
| POST | /api/subscriptions/checkout | orders:write | key | |||
| GET | /api/subscriptions/clients | orders:read | key | |||
| GET PUT DELETE | /api/subscriptions/credit-refill | orders:write | key | subscription_credit_refill | ||
| GET | /api/subscriptions/current | billing:read | key | account_subscription_current | ||
| POST | /api/subscriptions/customer-portal | orders:write | key | subscription_customer_portal | ||
| GET | /api/subscriptions/usage | billing:read | key | account_subscription_usage |
/api/target-pages (25)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET PATCH | /api/target-pages/[id] | orders:write | key | target_pages_update | ||
| GET | /api/target-pages/[id]/anchor-analysis | orders:write | key | |||
| GET POST | /api/target-pages/[id]/anchor-optimization | orders:write | 402 | receipt | key | |
| PUT PATCH | /api/target-pages/[id]/backlinks/[backlinkId] | orders:write | key | |||
| POST | /api/target-pages/[id]/classify-anchors | orders:write | key | |||
| POST | /api/target-pages/[id]/description | orders:write | key | |||
| PUT | /api/target-pages/[id]/description/update | client-config:write | key | |||
| POST | /api/target-pages/[id]/fetch-backlinks | orders:write | key | |||
| POST | /api/target-pages/[id]/import-backlinks | orders:write | key | |||
| GET PATCH | /api/target-pages/[id]/intelligence/brief | orders:read | key | |||
| POST | /api/target-pages/[id]/intelligence/cancel | orders:write | key | |||
| POST | /api/target-pages/[id]/intelligence/generate-brief | orders:write | key | |||
| GET | /api/target-pages/[id]/intelligence/latest | orders:read | key | |||
| GET | /api/target-pages/[id]/intelligence/logs | orders:read | key | |||
| POST | /api/target-pages/[id]/intelligence/start-research | orders:write | key | |||
| GET | /api/target-pages/[id]/intelligence/status | orders:read | key | |||
| POST | /api/target-pages/[id]/intelligence/submit-input | orders:write | key | |||
| POST | /api/target-pages/[id]/intelligence/update-answers | orders:write | key | |||
| POST | /api/target-pages/[id]/keywords | orders:write | key | |||
| PUT | /api/target-pages/[id]/keywords/update | orders:write | key | |||
| GET | /api/target-pages/[id]/line-items | orders:read | key | |||
| GET POST | /api/target-pages/[id]/plan | orders:write | key | |||
| GET POST DELETE | /api/target-pages/[id]/suggestions | orders:write | key | |||
| PATCH | /api/target-pages/[id]/suggestions/[suggestionId] | orders:write | key | |||
| POST | /api/target-pages/bulk-generate | orders:write | 402 | receipt | key |
/api/target-urls (1)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET | /api/target-urls/keywords | orders:read | key |
/api/vetted-sites (6)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET | /api/vetted-sites | vetted-sites:read | session only | |||
| POST PATCH | /api/vetted-sites/[domainId] | vetted-sites:write | session only (scope) | |||
| GET POST | /api/vetted-sites/requests | none | session only | |||
| GET PUT PATCH DELETE | /api/vetted-sites/requests/[id] | none | session only | |||
| GET POST DELETE | /api/vetted-sites/requests/[id]/strategy | none | session only | |||
| GET | /api/vetted-sites/target-urls | vetted-sites:read | session only (scope) |
/api/websites (7)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET | /api/websites | websites:read | key | |||
| GET | /api/websites/[id] | websites:read | key | |||
| GET | /api/websites/[id]/pages | websites:read | key | |||
| GET | /api/websites/export | none | session only | |||
| GET | /api/websites/export-pages | websites:read | key | |||
| POST PUT | /api/websites/search | websites:read | key | |||
| GET | /api/websites/workflow-selector | websites:read | key |
/api/workflows (18)
| Methods | Path | Scope | 402 | Receipt | Access | Tools |
|---|---|---|---|---|---|---|
| GET PUT PATCH DELETE | /api/workflows/[id] | workflows:read workflows:write | key | |||
| GET | /api/workflows/[id]/article | workflows:read | key | |||
| POST | /api/workflows/[id]/generate-listicle/sync | workflows:write | self-serve key | workflow_generate_listicle_sync | ||
| GET | /api/workflows/[id]/line-item-id | workflows:read | key | |||
| GET POST | /api/workflows/[id]/step-completed | workflows:read workflows:write | key | |||
| GET POST | /api/workflows/[id]/step-sync-status/[stepId] | none | session only | |||
| PATCH | /api/workflows/[id]/steps/[stepId]/outputs | workflows:write | key | |||
| POST | /api/workflows/[id]/steps/generate-insertion-brief/manual-listicle | workflows:write | key | |||
| POST | /api/workflows/[id]/topic-generation/finalize | workflows:write | key | |||
| POST | /api/workflows/[id]/topic-generation/phase-1/auto-select | workflows:write | key | |||
| POST | /api/workflows/[id]/trigger/resume | workflows:write | 402 | receipt | self-serve key | workflow_trigger_resume |
| POST | /api/workflows/[id]/trigger/start | workflows:write | 402 | receipt | self-serve key | workflow_trigger_start |
| GET | /api/workflows/[id]/trigger/status | workflows:read | key | workflow_trigger_status | ||
| GET POST | /api/workflows/[id]/verify-publication | publishers:read publishers:write | 402 | receipt | session only (scope) | |
| POST | /api/workflows/[id]/verify-publication/start | workflows:write | 402 | key | ||
| POST | /api/workflows/resolve-target-url | workflows:read | key | |||
| POST | /api/workflows/send-article-to-publisher | workflows:write | self-serve key | workflow_send_to_publisher | ||
| POST | /api/workflows/send-pre-approval | workflows:write | session only |