API reference
Get narration usage
This month's characters as InOrbit counts them and as ElevenLabs counts them (cached a day, plus what was spent since; refresh asks the provider again), the cap that applies and the plan.
Needs scope narration:read.
bearerAuthorizationBearer <token>An access token from the identity provider: a person's, or a customer's from the client credentials grant with an API key (developers.inorbit.hr). The gateway verifies it; the audience is iohr-api.
refresh?booleanAsk ElevenLabs again instead of answering the cache.
iohr.narration.v1.GetUsageResponse
application/json- response
iohr.narration.v1.GetUsageResponse
characters_cached*integerint32characters_spent*integerint32effective_monthly_characters*integerint32lines_spoken*integerint32month*stringplan*stringprovider?iohr.narration.v1.ProviderUsage
provider_note*stringimport { ApiError, Public } from "@inorbithr/sdk";// Reads INORBIT_TOKEN, or INORBIT_KEY_ID and INORBIT_KEY_SECRET.const api = Public.fromEnv();try { const { value } = await api.narration.getUsage(); console.log(value);} catch (e) { if (!(e instanceof ApiError)) throw e; console.error(`${e.code}: ${e.problem} (request id ${e.raw.requestId})`);}npm install @inorbithr/sdk. Calls the package's public surface; an operation newer than your package needs the next release or a client generated for your account. The SDKs.
{ "characters_cached": 0, "characters_spent": 0, "effective_monthly_characters": 0, "lines_spoken": 0, "month": "string", "plan": "string", "provider": { "characters_limit": "string", "characters_used": "string", "fetched_at": "string", "plan": "string", "provider": "string", "resets_at": "string", "status": "string" }, "provider_note": "string"}Get a clip GET
One narrated clip of the account's with its audio (MP3), per-character timings, its licence (the provider's plan when it was made, whether it may be used commercially, the voice) and the AI-voice disclosure. Needs scope `narration:read`.
List digests GET
Published Radar digests, newest week first. Needs scope `radar:read`.