Index sources | Algorhythm

curl -X POST https://api.algorhythm.app/v1/sources/index \
     -H "X-API-Key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "sound_ids": [
    "snd_8f3a2b1c",
    "snd_4d7e9f0a"
  ],
  "hashtags": [
    "ambient",
    "nature",
    "relaxing"
  ],
  "options": {
    "priority": "high",
    "index_type": "full",
    "retry_on_failure": true
  },
  "webhook_url": "https://example.com/webhook/index-callback"
}'

{
  "sources": [
    {
      "type": "sound",
      "id": "snd_8f3a2b1c",
      "task_id": "7c1f9e2a-4b88-4d3f-9a02-21cb5b8a4f12"
    },
    {
      "type": "sound",
      "id": "snd_4d7e9f0a",
      "task_id": "3a09c12b-4e2d-4a91-bc77-9e2b14f8a1c5"
    },
    {
      "type": "hashtag",
      "id": "ambient",
      "task_id": "92ef4b1d-87a3-4d22-a51e-7b6cf2d9018e"
    },
    {
      "type": "hashtag",
      "id": "nature",
      "task_id": "14c0d8a2-bef1-44a3-9d52-c107fa42e6b8"
    },
    {
      "type": "hashtag",
      "id": "relaxing",
      "task_id": "61b8a9d4-f3e7-4f9a-9d1b-72e3c145ab90"
    }
  ]
}

Queue one or more TikTok sounds and/or hashtags for indexing. Each source costs 1 credit. Indexing crawls posts, identifies creators, and computes trend and audience analytics. Use the status and download endpoints to retrieve results once complete.

Authentication

X-API-Keystring

API Key authentication via header

Request

This endpoint expects an object.

sound_idslist of stringsOptional

TikTok sound IDs to index.

hashtagslist of stringsOptional

TikTok hashtags to index (without the #).

optionsmap from strings to anyOptional

Optional indexing tuning. Supported keys: post_count (int), force_refresh (bool).

webhook_urlstring or nullOptional

Optional webhook to notify when indexing completes.

Response

Successful Response

sourceslist of objects

Errors

402

Payment Required Error

422

Unprocessable Entity Error