We made some API improvements behind the scene. No action is required on your end.
Better documentation
Listen API’s users are developers. The API documentation is the main UI for users :) Thus, we have to continuously improve the documentation.
Recently, we made OpenAPI spec for our API documentation.
OpenAPI is an API description format for REST APIs, which documents endpoints, parameters, response schemas, example responses, and some other meta data of the API. It’s machine readable, because it’s in either YAML or JSON format. This enables a lot of tools to streamline the development around the API.
You can take a quick look at Listen API’s OpenAPI spec in YAML or JSON. We generate the main documentation page from the standardized OpenAPI spec. Specifically, you can see the API response schema (e.g., data type, example value, default value, description…) on the page:
Response Schema
Furthermore, we embed Runkit widgets on the main documentation page to make it easy for you to test API endpoints and preview the actual response:
Send API Requests
Better performance
We did some infrastructure improvements (e.g., code optimization, server upgrade…) and reduced the average API response time from ~100 ms to ~85 ms.
You can always go to our status page to monitor the realtime health of Listen API: https://status.listennotes.com/
Bigger thumbnail images
We made the thumbnail images bigger (the “thumbnail” field in the API response)! Previously the thumbnail image was 150x150, which was very blurry on modern smartphone screens :) Now the image is 300x300.
As always, if you use Listen API and you have any questions, contact us: hello@listennotes.com
