Skip to content
ANKK APPANKK Docs

API Quickstart

The ANKK Public API is a RESTful API that allows programmatic management of your multi-channel social media operations using a single brand-scoped API key (spk_...).

📌 Endpoint Overview

Section titled “📌 Endpoint Overview”
  • Base URL: https://api.ankk.app
  • Swagger / Interactive Docs: https://api.ankk.app/v1/docs
  • OpenAPI JSON Spec: https://api.ankk.app/v1/openapi.json

1. Check Service Health

Section titled “1. Check Service Health”

Health check endpoints do not require authentication headers.

Terminal window
curl https://api.ankk.app/v1/health
{
  "service": "api-public",
  "status": "ok"
}

2. Obtain & Export Your API Key

Section titled “2. Obtain & Export Your API Key”

In the web app (https://app.ankk.app), navigate to Brand Settings → API Keys to generate a key, then export it:

Terminal window
export ANKK_API_KEY='spk_live_xxxxxxxxxxxxxxxx'

3. Retrieve Brand & SNS Connections

Section titled “3. Retrieve Brand & SNS Connections”

Check your brand status and list connected SNS accounts to obtain target connection_ids.

cURL

Section titled “cURL”
Terminal window
# 1. Inspect brand details
curl https://api.ankk.app/v1/brand \
  -H "Authorization: Bearer $ANKK_API_KEY"


# 2. List connected SNS accounts
curl https://api.ankk.app/v1/brand/connections \
  -H "Authorization: Bearer $ANKK_API_KEY"

TypeScript / JavaScript

Section titled “TypeScript / JavaScript”
const API_KEY = process.env.ANKK_API_KEY;
if (!API_KEY) throw new Error('Set ANKK_API_KEY');
const BASE_URL = 'https://api.ankk.app/v1';


const res = await fetch(`${BASE_URL}/brand/connections`, {
  headers: {
    Authorization: `Bearer ${API_KEY}`
  }
});
if (!res.ok) throw new Error(`Connections request failed: ${res.status}`);
const { items: connections } = await res.json();
console.log('Connected accounts:', connections);
const targetConnectionId = connections[0]?.connection_id;
if (!targetConnectionId) throw new Error('Connect an SNS account first');

Python

Section titled “Python”
import os
import requests


API_KEY = os.environ['ANKK_API_KEY']
BASE_URL = 'https://api.ankk.app/v1'


headers = {'Authorization': f'Bearer {API_KEY}'}


response = requests.get(f'{BASE_URL}/brand/connections', headers=headers)
response.raise_for_status()
connections = response.json().get('items', [])
print(f'Connected accounts: {connections}')
target_connection_id = connections[0]['connection_id'] if connections else None
if not target_connection_id:
    raise RuntimeError('Connect an SNS account first')

4. Publish Your First Content

Section titled “4. Publish Your First Content”

Submit a publishing request with a client-generated idempotency_key to avoid duplicate executions.

cURL

Section titled “cURL”
Terminal window
curl -X POST "https://api.ankk.app/v1/brand/contents" \
  -H "Authorization: Bearer $ANKK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "connection_id": "conn_01jm8x9k2example",
    "idempotency_key": "my-first-post-001",
    "text": "Hello World from ANKK Public API! 🚀"
  }'

TypeScript / JavaScript

Section titled “TypeScript / JavaScript”
const publishRes = await fetch(`${BASE_URL}/brand/contents`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    connection_id: targetConnectionId,
    idempotency_key: 'my-first-post-001',
    text: 'Hello World from TypeScript! 🚀'
  })
});


if (publishRes.status !== 202) throw new Error(`Publish request failed: ${publishRes.status}`);
const result = await publishRes.json();
console.log('Publish accepted (HTTP 202):', result);

Python

Section titled “Python”
payload = {
    'connection_id': target_connection_id,
    'idempotency_key': 'my-first-post-001',
    'text': 'Hello World from Python! 🚀',
}


publish_res = requests.post(
    f'{BASE_URL}/brand/contents',
    headers={**headers, 'Content-Type': 'application/json'},
    json=payload,
)
publish_res.raise_for_status()
print('Publish outcome:', publish_res.json())

5. Verify Publication Status

Section titled “5. Verify Publication Status”

A successful request returns HTTP 202 Accepted and a content_id. Verify delivery status via:

Terminal window
curl "https://api.ankk.app/v1/brand/contents/$CONTENT_ID" \
  -H "Authorization: Bearer $ANKK_API_KEY"

🔗 Next Steps

Section titled “🔗 Next Steps”