API Reference / Speakers

List speakers

GET/v1/speakers

Lists the speakers of your account, newest first, with how many voice samples each has. Use limit and cursor to page through long lists. Requires scope speakers:read.

Authentication

Send your API key as Authorization: Bearer <your API key>.

Headers

Name	Type	Details
`Authorization`required	string	`Bearer <your API key>`. Keys are created in the dashboard; see Authentication.

Query parameters

Name	Type	Details
`limit`optional	integer	How many speakers to return (1-100). 1 to 100default `20`
`cursor`optional	string or null	`next_cursor` from the previous page. at most 256 characters

Response

200 Success.

request_idstringrequired
objectstringrequired
always "list"
dataarray of objectrequired
5 fields in data
- speaker_idstringrequired
  pattern ^[A-Za-z0-9_.:-]{1,64}$
- display_namestring or nullrequired
- samplesintegerrequired
  Active enrollment samples for the current speaker model (max 5).
- created_atstringrequired
- updated_atstringrequired
has_morebooleanrequired
next_cursorstring or nullrequired

Example response

JSON

{
  "request_id": "req_8f14e45fceea167a5a36dedd",
  "object": "list",
  "data": [
    {
      "speaker_id": "customer-4711",
      "display_name": "Ada Lovelace",
      "samples": 2,
      "created_at": "2026-10-13T09:30:00Z",
      "updated_at": "2026-10-13T09:41:12Z"
    }
  ],
  "has_more": false
}

Errors

Status	Meaning
400	The request is invalid, for example a missing or malformed field.
401	The API key is missing, invalid or revoked.
403	The key lacks the required scope, the email address is not verified, or the account is suspended.
429	Too many requests or too many operations at the same time. Wait for the number of seconds in Retry-After.
500	Something went wrong on our side. No credits were used.

Error bodies share one shape with a stable error.code; see Errors for every code and how to fix it.

Code samples

cURL

curl "https://platform.detectif.ai/v1/speakers" \
  -H "Authorization: Bearer $DETECTIF_API_KEY"

Python

import os

import requests

resp = requests.get(
    "https://platform.detectif.ai/v1/speakers",
    headers={"Authorization": f"Bearer {os.environ['DETECTIF_API_KEY']}"},
    timeout=30,
)
print(resp.status_code, resp.json())

JavaScript

const res = await fetch("https://platform.detectif.ai/v1/speakers", {
  headers: {
    Authorization: `Bearer ${process.env.DETECTIF_API_KEY}`,
  },
});
console.log(res.status, await res.json());

#Authentication

#Headers

#Query parameters

#Response

#Example response

#Errors

#Code samples