Skip to main content

Intel API

The Intel API allows you to access competitive intelligence data, including evidence and internal notes.

List Intel Items​

Get intel items for your workspace. Supports filtering by competitor ID or specific IDs.

GET /api/intel?competitorId={competitorId}&ids={id1,id2,id3}

Query Parameters​

  • competitorId (string, optional) - Filter intel items by competitor ID
  • ids (string, optional) - Comma-separated list of intel item IDs

Response​

{
  "intelItems": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "workspaceId": "workspace-id",
      "competitorId": "competitor-id",
      "type": "EVIDENCE",
      "content": "Evidence content text",
      "metadata": {
        "sourceType": "WEB_PAGE",
        "url": "https://example.com/source",
        "title": "Source Title",
        "credibilityScore": 0.95,
        "ingestedAt": "2024-01-01T00:00:00.000Z"
      }
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655440001",
      "workspaceId": "workspace-id",
      "competitorId": "competitor-id",
      "type": "INTERNAL_NOTE",
      "content": "Internal note content",
      "metadata": {
        "sourceType": "INTERNAL_NOTE",
        "createdByUserId": "user-id",
        "ingestedAt": "2024-01-01T00:00:00.000Z"
      }
    }
  ]
}

Type Values​

  • EVIDENCE - Evidence collected from external sources (web pages, documents, etc.)
  • INTERNAL_NOTE - Internal notes added by your team

Source Types​

  • WEB_PAGE - Web page content
  • DOCUMENT - Document content
  • INTERNAL_NOTE - Internal note
  • Other source types may be added over time

Create Intel Item​

Create a new intel item (internal note). Requires EDITOR role or higher.

POST /api/intel

Request Body​

{
  "competitorId": "competitor-id",
  "content": "Internal note content",
  "type": "INTERNAL_NOTE"
}

Required Fields​

  • competitorId (string) - Competitor ID
  • content (string) - Intel item content

Optional Fields​

  • type (string) - Intel item type. Defaults to "INTERNAL_NOTE". Currently only "INTERNAL_NOTE" is supported for creation.

Response​

{
  "intelItem": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "workspaceId": "workspace-id",
    "competitorId": "competitor-id",
    "type": "INTERNAL_NOTE",
    "content": "Internal note content",
    "metadata": {
      "sourceType": "INTERNAL_NOTE",
      "createdByUserId": "user-id",
      "ingestedAt": "2024-01-01T00:00:00.000Z"
    }
  }
}

Error Responses​

  • 400 - Bad Request (missing required fields)
  • 401 - Unauthorized (invalid or missing API key)
  • 403 - Forbidden (insufficient permissions)
  • 404 - Not Found (competitor doesn't exist)