# Creator voice usage

`GET https://api.vidmoat.com/v1/speech/voices/{id}/usage`

- Scope: `speech.read`
- Cost: Free

Owner-only counts of distinct other creators, completed external generations and own generations. Failed jobs, retries and drafting do not inflate usage. Does not reveal other accounts or scripts.

### Path parameters

- `id` (string, required): A voice or generation ID belonging to the credential owner.

## Response

Returns `200`.

### Response fields

- `generations` (number): Completed generations by other creators.
- `creators` (number): Distinct other creators with completed generations.
- `ownGenerations` (number): Your completed generations.

## Errors

Besides the errors any request can get ([authentication](https://developer.vidmoat.com/developer/docs/authentication#when-a-request-is-refused), [rate limits](https://developer.vidmoat.com/developer/docs/rate-limits)):

| Status | Code | When |
| --- | --- | --- |
| 409 | [`conflict`](https://developer.vidmoat.com/developer/docs/errors#conflict) | The idempotency key belongs to different inputs, or the job is not in the required state. |
| 503 | [`unavailable`](https://developer.vidmoat.com/developer/docs/errors#unavailable) | Inference, private storage, configured pilot billing or the limiter is unavailable. Nothing new is charged before admission. |

## Request examples

```bash curl
curl --fail-with-body "https://api.vidmoat.com/v1/speech/voices/$ID/usage" -H "Authorization: Bearer $VIDMOAT_KEY"
```

```js Node
const ID = 'YOUR_PROJECT_ID';

const res = await fetch(`https://api.vidmoat.com/v1/speech/voices/${ID}/usage`, {
  headers: {
    Authorization: `Bearer ${process.env.VIDMOAT_KEY}`,
  },
});
const data = await res.json();
if (!res.ok) throw new Error(data.error?.message ?? `HTTP ${res.status}`);
console.log(data);
```

```python Python
import os
import requests

ID = "YOUR_PROJECT_ID"

res = requests.get(
    f"https://api.vidmoat.com/v1/speech/voices/{ID}/usage",
    headers={"Authorization": f"Bearer {os.environ['VIDMOAT_KEY']}"},
    timeout=60,
)
res.raise_for_status()
print(res.json())
```

---

Source: https://developer.vidmoat.com/developer/docs/api/speech/voice-usage
Previous: [Discover voices](https://developer.vidmoat.com/developer/docs/api/speech/list-voices.md)
Next: [Direct a narration draft](https://developer.vidmoat.com/developer/docs/api/speech/direction.md)
All documentation: https://developer.vidmoat.com/llms-full.txt