Links

Link Engine for internal linking

List Link Engine sites

get

Returns sites with Link Engine configuration. Requires Power plan or higher.

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Query parameters

pageintegerOptional

searchstringOptional

Search by domain

categorystring · uuidOptional

statusstring · enumOptionalPossible values:

Responses

200

List of Link Engine sites

application/json

get

/v1/links

HTTPcURLJavaScriptPython

GET /v1/links HTTP/1.1
Host: api.cuppa.ai
X-API-KEY: YOUR_API_KEY
Accept: */*

200

List of Link Engine sites

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "domain": "text",
      "link_engine_status": "active",
      "link_engine_url_count": 1,
      "link_engine_last_indexed_at": "2026-03-22T03:46:23.827Z",
      "link_engine_error": "text",
      "category_id": "123e4567-e89b-12d3-a456-426614174000",
      "category_name": "text",
      "has_link_config": true,
      "created_at": "2026-03-22T03:46:23.827Z"
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 1,
    "total": 1,
    "total_pages": 1
  }
}

Get Link Engine statistics

get

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Responses

200

Link Engine stats

application/json

total_sitesintegerOptional

active_sitesintegerOptional

paused_sitesintegerOptional

indexing_sitesintegerOptional

error_sitesintegerOptional

total_urlsintegerOptional

get

/v1/links/stats

HTTPcURLJavaScriptPython

GET /v1/links/stats HTTP/1.1
Host: api.cuppa.ai
X-API-KEY: YOUR_API_KEY
Accept: */*

200

Link Engine stats

{
  "total_sites": 1,
  "active_sites": 1,
  "paused_sites": 1,
  "indexing_sites": 1,
  "error_sites": 1,
  "total_urls": 1
}

List link categories

get

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Responses

200

List of categories

application/json

idstring · uuidOptional

namestringOptional

slugstringOptional

descriptionstring · nullableOptional

colorstringOptional

site_countintegerOptional

created_atstring · date-timeOptional

get

/v1/links/categories

HTTPcURLJavaScriptPython

GET /v1/links/categories HTTP/1.1
Host: api.cuppa.ai
X-API-KEY: YOUR_API_KEY
Accept: */*

200

List of categories

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "slug": "text",
    "description": "text",
    "color": "text",
    "site_count": 1,
    "created_at": "2026-03-22T03:46:23.827Z"
  }
]

Create a link category

post

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Body

application/json

namestring · max: 50Required

descriptionstring · max: 200Optional

colorstringOptionalDefault: #6366f1Pattern: ^#[0-9A-Fa-f]{6}$

Responses

201

Category created

application/json

post

/v1/links/categories

HTTPcURLJavaScriptPython

POST /v1/links/categories HTTP/1.1
Host: api.cuppa.ai
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "name": "text",
  "description": "text",
  "color": "#6366f1"
}

201

Category created

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "slug": "text",
  "description": "text",
  "color": "text",
  "site_count": 1,
  "created_at": "2026-03-22T03:46:23.827Z"
}