Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.bota.dev/llms.txt

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

All top-level API resources (EndUsers, Devices, Recordings, etc.) support bulk retrieval via “List” endpoints. To keep responses fast and manageable, Bota uses a standard limit-and-offset pagination model.

​
Query Parameters

Use the following query parameters to control the results returned in a list.
ParameterDefaultMaxDescription
limit25100A limit on the number of objects to be returned.
offset0-A cursor for use in pagination. Offset skips the first N results.

​
Example Request

# Get the third page of recordings (items 21-30)
curl "https://api.bota.dev/v1/recordings?limit=10&offset=20" \
  -H "Authorization: Bearer sk_live_..."

​
Response Structure

List responses always return an object with a data array and a has_more boolean. 
{
  "data": [
    { "id": "rec_1", "status": "completed", ... },
    { "id": "rec_2", "status": "completed", ... }
    // ... up to 10 items
  ],
  "has_more": true
}

​
Attributes

AttributeTypeDescription
dataarrayThe list of resources requested.
has_morebooleantrue if there are more results available beyond this page.

​
Best Practices

​
Iterating through all results

To fetch every resource in a list, start with offset=0 and increment the offset by your limit until has_more returns false.

​
Default Sorting

Unless otherwise specified, Bota returns lists sorted by created_at in descending order (newest first).