Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.lyrcs.ai/llms.txt

Use this file to discover all available pages before exploring further.

Endpoint

GET https://lyrcs.ai/api/v1/usage
Returns job counts, total audio duration processed, a breakdown by language, and total API call count for your organisation.

Response

{
  "org_id": "org_abc123",
  "period": "all_time",
  "total_jobs": 142,
  "completed_jobs": 138,
  "total_duration_seconds": 49320,
  "jobs_by_language": {
    "Hindi": 58,
    "Tamil": 44,
    "Telugu": 22,
    "Punjabi": 18
  },
  "api_calls": 612
}

Response fields

FieldTypeDescription
org_idstringYour organisation ID
periodstringAlways "all_time" — no date filtering currently
total_jobsnumberTotal jobs submitted via API
completed_jobsnumberJobs where both transcript and LRC are present
total_duration_secondsnumberSum of audio duration across all API jobs
jobs_by_languageobjectJob count keyed by language name
api_callsnumberTotal API requests made by this organisation

Examples

curl https://lyrcs.ai/api/v1/usage \
  -H "Authorization: Bearer $LYRCS_API_KEY"