The Daily API uses API keys to authenticate requests.
Almost all of the Daily API endpoints require that you include your API key in the
Authorization header of your HTTP request. For example:
Each API key is tied to a specific Daily domain.
You should keep your API key secret. Never use the API key in client-side web browser code, for example.
If an API call requires authentication, but no
Authorization: Bearer header is present, we return an HTTP
400 error, with a body that includes an
error parameter set to the string
If an API call requires authentication but the API key provided in the authorization header isn't valid, we return an HTTP
401 error, with a body that includes an
error parameter set to the string
The Daily API endpoints all return errors, wherever possible, as HTTP
5xx error responses.
Error response bodies generally includes two parameters:
error parameter is a string indicating an error type, and the
info parameter fills in a bit more human readable information, wherever available.
error types are stable; we don't expect to change them (though we'll likely add new error types over time.) But please treat the
info strings only as additional information you use while developing and debugging. Content of the
info parameter is not fixed and may change as we improve error feedback.
|HTTP status code||Response||Interpretation|
|200||OK||Everything worked as expected.|
|400||Bad Request||The operation could not be performed as requested.|
|401||Unauthorized||The provided API key is was not valid.|
|404||Not Found||The requested REST resource did not exist.|
|429||Too Many Requests||Too many requests were sent in too short a period of time. Please throttle your request rate.|
|5xx||Server Errors||Something unexpected happened on the server side. Please ping us to report this, if possible.|
|authentication-error||The API key is not valid.|
|authorization-header-error||The Authorization header is missing or badly formatted.|
|json-parsing-error||The JSON request body could not be parsed.|
|invalid-request-error||The request could not be performed. More information is usually available in the info field of the response body. Typical causes are missing required parameters, bad parameter values, etc.|
|rate-limit-error||Too many requests were sent in too short a period of time. Please throttle your request rate.|
|server-error||Something unexpected went wrong.|
All pagination arguments are optional. Without any pagination arguments, the list methods return up to 100 data objects, sorted in reverse chronological order by creation time. (In other words, by default, you just get back a list of your most recently created room or recording objects!)
It's helpful to think of pagination arguments — as the name suggests — in terms of defining "pages" of results.
limitargument sets the size of the page (how many objects each page contains), and defaults to a value of 100.
starting_afterargument sets the starting point of the page and is used to fetch "subsequent" pages of results – as if you were paging through a book from front to back.
ending_beforeargument is the opposite, and is used to fetch previous pages of results -- as if you were paging through a book from back to front.
- A special
OLDEST, is available to facilitate fetching pages of results "backwards," from oldest objects to newest.
Note that the granularity for
created_at timestamps is one second. The returned list order is stable, because
id is the secondary sort field. But if you create multiple rooms within a 1-second window, the list order may not be precisely reverse-chronological.
|limit||A limit on the number of objects to be returned. Maximum value is 100. Default value (if not supplied) is 100.|
|starting_after||An object id to be used as a pagination cursor. The first object returned will be the object immediately after the object this id. This argument is commonly used to fetch the "next" page of results.|
|ending_before||The opposite of starting_after. The last page of returned results will be the object immediately preceding the object with this id. The special value OLDEST fetches the "last" page of results (the page containing the objects created longest ago).|
Here's what code looks like that fetches and does something will all of your room objects. We've left error checking as an exercise for the reader.