Usage

Retrieve Speech-to-Video Session Usage

Changed on

Retrieve the usage of each speech-to-video session.

Lists the sessions created in the range, in UTC days, that have started and ended. The figures are seconds as your plan counts them, and cover every workspace of your organization, so only an API key of the default workspace can read them. Agent conversations and text-to-video are not included.

The days are UTC calendar days, so they do not line up with your billing period; Retrieve Usage gives the usage of your billing period. A range spans at most 366 days and 10,000 sessions; split a busier range into shorter ones.

get/v1/usage/sessions

Request

  • Base URL
    https://api.bey.dev
  • URL
    https://api.bey.dev/v1/usage/sessions
  • Auth
    API key in header x-api-key

Query parameters

startstring date required

Earliest day a listed session was created, in UTC (YYYY-MM-DD).

endstring date required

Latest day a listed session was created, in UTC (YYYY-MM-DD).

Response

Successful Response

Example response

{
  "data": [
    {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "avatar_id": "01234567-89ab-cdef-0123-456789abcdef",
      "started_at": "2026-10-01T09:00:00+00:00",
      "ended_at": "2026-10-01T09:30:30+00:00",
      "used_seconds": 1830
    }
  ]
}

Changes

    • breaking

      removed the required property // from the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      endpoint added