StalkrDevelopers

OpenAPI Dashboard

Overview Quickstart Authentication REST API MCP Webhooks Errors & limits

REST

Agent API

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

Request conventions

Send a Bearer token in the Authorization header.
Send JSON objects for POST, PATCH, and DELETE bodies; the maximum body is 64 KB.
Use Idempotency-Key on writes. Keys are retained for 24 hours.
Optional X-Request-Id values appear in responses and activity logs.
List endpoints use bounded limits and cursor pagination where applicable.

Authorization: Bearer $STALKR_API_KEY
Content-Type: application/json
Idempotency-Key: unique-operation-key
X-Request-Id: trace-from-your-system

Response envelope

{
  "data": { /* operation result */ },
  "meta": {
    "capability": "update_mention_status",
    "requestId": "...",
    "idempotencyReplayed": false
  }
}

Stable contract

The data shape is operation-specific. Transport metadata always lives under meta, and failures always use an error envelope.

Operations

GET/projectsList projects GET/projects/:projectIdGet project POST/projectsCreate project PATCH/projects/:projectIdUpdate project DELETE/projects/:projectIdArchive project GET/projects/:projectId/membersList project members POST/projects/:projectId/membersInvite project member PATCH/projects/:projectId/members/:memberIdUpdate project member DELETE/projects/:projectId/members/:memberIdRemove project member GET/keywordsList keywords POST/keywordsCreate keyword PATCH/keywords/:keywordIdUpdate keyword DELETE/keywords/:keywordIdStop tracking keyword GET/mentionsList mentions GET/mentions/:mentionIdGet mention PATCH/mentions/:mentionIdUpdate mention status GET/categoriesList categories POST/categoriesCreate category PATCH/categories/:categoryIdUpdate category DELETE/categories/:categoryIdDelete category GET/mention-viewsList saved mention views POST/mention-viewsCreate saved mention view PATCH/mention-views/:viewIdUpdate saved mention view DELETE/mention-views/:viewIdDelete saved mention view GET/alertsList alerts POST/alertsCreate alert PATCH/alerts/:alertIdUpdate alert DELETE/alerts/:alertIdDelete alert GET/integrations/linkedinGet LinkedIn integration POST/integrations/linkedin/connect-urlGet LinkedIn connect URL PATCH/integrations/linkedinSelect LinkedIn Page POST/integrations/linkedin/syncSync LinkedIn now DELETE/integrations/linkedinDisconnect LinkedIn GET/accountGet account PATCH/accountUpdate account DELETE/accountDelete account GET/usageGet usage and limits GET/webhooksList webhooks POST/webhooksCreate webhook PATCH/webhooks/:endpointIdUpdate webhook DELETE/webhooks/:endpointIdDelete webhook POST/webhooks/:endpointId/testTest webhook GET/webhooks/:endpointId/deliveriesList webhook deliveries POST/webhooks/:endpointId/deliveries/:deliveryId/replayReplay webhook delivery

Machine-readable schema

The complete OpenAPI 3.1 document is generated at build/request time from live Zod capability schemas.

Open /openapi.json →