Copy page

Using the API

API Endpoints

The IntelCenter API provides access to intelligence data through a RESTful interface.

All endpoints are versioned and currently available under:

https://api.intelcenter.com/v1

---

Overview

The API is organized into datasets and capabilities. Each dataset follows a consistent pattern:

• Search — retrieve paginated results with filtering and sorting
• Get by UUID — retrieve detailed record data
• Media Access — retrieve a player or viewer URL (where applicable)

In addition, the API provides:

• Natural Language Search — concept-based search across datasets
• Domain GenAI — AI-powered question answering over intelligence data

---

Available Datasets

Video Data

• ICD Video — /v1/icd/videos
• ICDB Video — /v1/icdb/videos

Image Data

• ICD Image — /v1/icd/images
• ICDB Image — /v1/icdb/images

---

Advanced Capabilities

Natural Language Search

Search across transcripts, summaries, visual analysis, and metadata using natural language.

• /v1/icd/nl-search
• /v1/icdb/nl-search

Example:

Code
curl --request GET \
  --url "https://api.intelcenter.com/v1/icd/nl-search?search=missile launches near coastal area" \
  --header "Authorization: Bearer YOUR_API_KEY"

Best for:

• Conceptual queries
• Descriptive searches
• Situational discovery

---

Domain GenAI

Ask analytical questions and receive synthesized answers based on IntelCenter intelligence data.

• /v1/icd/domain-genai
• /v1/icdb/domain-genai

Example:

Code
curl --request POST \
  --url https://api.intelcenter.com/v1/icd/domain-genai \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "question": "What recent activity has been observed involving naval drones?",
    "top_k": 5
  }'

Best for:

• Analytical questions
• Intelligence summaries
• Cross-source synthesis

---

Common Endpoint Patterns

Search

Retrieve a list of records with optional filtering, pagination, and sorting.

Code
GET /v1/{dataset}

Example:

Code
curl --request GET \
  --url "https://api.intelcenter.com/v1/icdb/videos?search=houthis&page=1&per_page=10" \
  --header "Authorization: Bearer YOUR_API_KEY"

---

Supported Query Parameters

• search — full text search across indexed fields
• entity — filter by associated entity
• country — filter by primary country
• page — page number (starting at 1)
• per_page — number of results per page
• date_from — return results on or after this date (YYYY-MM-DD)
• date_to — return results on or before this date (YYYY-MM-DD)
• sort — optional sorting (advanced usage)

Additional parameters (NL search):

• source_component — filter by content type
• top_k — control retrieval depth

All parameters are optional and can be combined.

---

Get by UUID

Retrieve detailed information for a specific record.

Code
GET /v1/{dataset}/{uuid}

Example:

Code
curl --request GET \
  --url https://api.intelcenter.com/v1/icdb/videos/{uuid} \
  --header "Authorization: Bearer YOUR_API_KEY"

Replace {uuid} with the record identifier.

---

Media Access

Retrieve a secure media URL for playback or viewing.

Video Player

Code
GET /v1/{dataset}/{uuid}/player

Example:

Code
curl --request GET \
  --url https://api.intelcenter.com/v1/icdb/videos/{uuid}/player \
  --header "Authorization: Bearer YOUR_API_KEY"

Image Viewer

Code
GET /v1/{dataset}/{uuid}/viewer

Example:

Code
curl --request GET \
  --url https://api.intelcenter.com/v1/icdb/images/{uuid}/viewer \
  --header "Authorization: Bearer YOUR_API_KEY"

---

MCP Endpoints

In addition to REST endpoints, the IntelCenter API provides MCP (Model Context Protocol) endpoints for AI assistants and automation tools.

Available MCP Routes

• /mcp-icd — ICD datasets only
• /mcp-all — ICD + ICDB datasets

Available MCP Tools

MCP exposes tools corresponding to API operations, including:

• Video search and retrieval
• Image search and retrieval
• Media player and viewer access
• Natural language search
• Domain GenAI chat

Examples:

• searchIcdVideos
• searchIcdbImages
• searchIcdNl
• searchIcdbNl
• icdDomainGenAiChat
• icdbDomainGenAiChat

Notes on MCP Usage

• MCP tools map directly to REST endpoints
• Parameters are automatically translated
• Access is controlled by your API key permissions
• Some tools may be unavailable depending on dataset or feature access

---

Consistent Response Structure

All search endpoints return a standardized paginated response:

• items — array of results
• itemsReceived — number of items in current response
• curPage — current page
• nextPage / prevPage — navigation
• perPage — results per page
• itemsTotal — total matching records
• pageTotal — total number of pages

This consistent structure applies across all datasets.

---

Access Control

Access to datasets and features is controlled per API key.

• Some keys may only access ICD datasets
• Some keys may have restricted ICDB entity access
• Some keys may not include Natural Language or Domain GenAI capabilities

If access is not permitted, the API will return a 403 Forbidden response.

---

Next Steps

• Explore the API Reference for full endpoint details
• Test queries with different filters and pagination
• Use Natural Language Search for exploratory queries
• Use Domain GenAI for analytical workflows
• Integrate endpoints into your applications or MCP workflows