Skip to main content

​
Authentication

Every request requires your API key in the Authorization header:
Requests without a valid key are rejected with a 401 error. See Create Your Key.

​
Indexing Pipeline

When you upload content, the platform runs two indexing pipelines in parallel and automatically — you don’t need to trigger them:

​
Task Status

Every uploaded item has a processing status: To wait for PARSE, either register a callback URL at upload time, or poll the status. The right polling endpoint depends on the upload method — see Upload Overview → How to wait for indexing to finish for the per-method mapping.

​
A Note on Field Casing

The Visual Search API mixes camelCase and snake_case across endpoints. The same logical concept can appear with different casings in different responses or parameter names: Pass the value through verbatim — both casings refer to the same underlying ID. Each endpoint page documents the exact field names it uses.

​
Callback Notifications

When you provide a callback URL on upload, the platform POSTs to it when indexing finishes:
The platform retries up to 5 times on failure. Use a tool like Beeceptor to test webhook delivery during development.

​
Folders (folder_id)

Organize your library into folders. Every upload can target a folder via folder_id, and every list/search can be scoped to one folder. Folders are managed through the Folder Management endpoints (list, create, rename, delete, and move videos between folders).
  • On upload — omit folder_id (or pass -1) to store in your account’s Default folder, created automatically on first use. Pass a folder id to store in that folder.
  • On list / search — omit folder_id to query across your entire account; pass a folder id to scope to that folder.
  • Create folders with Create Folder, list them with List Folders, and reorganize existing videos with Move Videos.
Migration note: the old unique_id namespace parameter has been removed. Every request is now scoped to your whole account; organize content with folder_id and the Folder Management endpoints instead.

​
Rate Limits & Billing

  • All endpoints are rate-limited per account. See Rate Limits.
  • Uploads and searches deduct credits from your account balance. Insufficient balance causes requests to fail.