ChatterBeamDevelopers
REST

Agent API

A versioned JSON API generated from the same capability registry as MCP. Base URL: /api/v1.

Request conventions

  • Send a Bearer token in the Authorization header.
  • Send JSON for writes; request bodies are capped at 64 KB.
  • Use Idempotency-Key on writes; completed keys remain valid for 24 hours.
  • Optional X-Request-Id values appear in responses and activity logs.
  • List operations use bounded limits and opaque cursors where supported.
Authorization: Bearer $CHATTERBEAM_API_KEY
Content-Type: application/json
Idempotency-Key: unique-operation-key
X-Request-Id: trace-from-your-system

Response envelope

{
  "data": { },
  "meta": {
    "capability": "update_mention_status",
    "requestId": "...",
    "idempotencyReplayed": false,
    "rateLimit": { }
  }
}

Operations

GET/projectsList projectsGET/projects/archivedList archived projectsGET/projects/:projectIdGet projectPOST/projectsCreate projectPATCH/projects/:projectIdUpdate projectGET/projects/:projectId/public-dashboardGet public dashboard settingsPATCH/projects/:projectId/public-dashboardSet public dashboard accessDELETE/projects/:projectIdArchive projectPOST/projects/:projectId/restoreRestore projectGET/projects/:projectId/membersList project membersPOST/projects/:projectId/membersInvite project memberPATCH/projects/:projectId/members/:memberIdUpdate project memberDELETE/projects/:projectId/members/:memberIdRemove project memberGET/keyword-groupsList keyword groupsPOST/keyword-groupsCreate keyword groupPATCH/keyword-groups/:groupIdUpdate keyword groupDELETE/keyword-groups/:groupIdDelete keyword groupGET/keywordsList keywordsPOST/keywordsCreate keywordPATCH/keywords/:keywordIdUpdate keywordDELETE/keywords/:keywordIdStop tracking keywordGET/scansList scan runsPOST/scansScan projectGET/mention-authorsSearch mentioning accountsGET/mentionsList mentionsGET/mentions/:mentionIdGet mentionPOST/mentions/:mentionId/irrelevantMark mention irrelevantPATCH/mentions/:mentionIdUpdate mention statusGET/analytics/mentionsGet mention analyticsGET/categoriesList categoriesPOST/categoriesCreate categoryPATCH/categories/:categoryIdUpdate categoryDELETE/categories/:categoryIdDelete categoryGET/mention-viewsList mention viewsPOST/mention-viewsCreate mention viewPATCH/mention-views/:viewIdUpdate mention viewDELETE/mention-views/:viewIdDelete mention viewGET/alertsList alertsPOST/alertsCreate alertPATCH/alerts/:alertIdUpdate alertDELETE/alerts/:alertIdDelete alertPOST/alerts/:alertId/testTest alertGET/integrations/providersList provider integrationsPUT/integrations/providers/:providerIdSave provider integrationPOST/integrations/providers/:providerId/testTest provider integrationDELETE/integrations/providers/:providerIdDelete provider integrationGET/integrations/linkedinGet linkedin integrationPOST/integrations/linkedin/connect-urlGet LinkedIn connect URLPATCH/integrations/linkedinSelect LinkedIn PagePOST/integrations/linkedin/syncSync LinkedIn nowDELETE/integrations/linkedinDisconnect LinkedInGET/accountGet accountPATCH/accountUpdate accountDELETE/accountDeactivate accountGET/usageGet usageGET/webhooksList webhooksPOST/webhooksCreate webhookPATCH/webhooks/:endpointIdUpdate webhookDELETE/webhooks/:endpointIdDelete webhookPOST/webhooks/:endpointId/testTest webhookGET/webhooks/:endpointId/deliveriesList webhook deliveriesPOST/webhooks/:endpointId/deliveries/:deliveryId/replayReplay webhook delivery

Machine-readable schema

The OpenAPI 3.1 document is generated from the same live capability metadata.

Open OpenAPI JSON