Skip to main content
GET
/
v1
/
history
cURL
curl \
  --request GET \
  --url "https://api.breeze.blue/v1/history" \
  --header "xi-api-key: $BREEZE_API_KEY"
{
  "history": [
    {
      "history_item_id": "<string>",
      "source": "<string>",
      "voice_id": "<string>",
      "voice_name": "<string>",
      "voice_category": "<string>",
      "model_id": "<string>",
      "text": "<string>",
      "state": "<string>",
      "content_type": "<string>",
      "date_unix": 123,
      "request_id": "<string>",
      "latency_ms": 123,
      "http_status": 123,
      "billable_units": 123,
      "cost": 123,
      "cost_millicredits": 123
    }
  ],
  "has_more": true,
  "total": 123,
  "page": 123,
  "page_size": 123,
  "last_history_item_id": "<string>"
}

Authorizations

xi-api-key
string
header
required

Breeze Developer API key.

Query Parameters

voice_id
string | null

Filter by voice_id.

model_id
string | null

Filter by model_id.

search
string | null

Filter by script text.

sort_direction
string
default:desc

Sort direction: asc or desc.

start_after_history_item_id
string | null

Cursor for forward pagination.

from
string | null
to
string | null
status_class
string | null
page
integer
default:1

Page number for offset pagination.

Required range: x >= 1
page_size
integer
default:50

Records per page.

Required range: 1 <= x <= 100

Response

Paginated history list.

history
HistoryItemResponse · object[]
required
has_more
boolean
required
total
integer
required
page
integer
required
page_size
integer
required
last_history_item_id
string | null