REST API

We've opened up parts of our backend so you can utilise them using an API to build whatever you want. All endpoints use JSON for sending and receiving date.

If you want to use our API, you can manage your Clients and Personal Access Tokens in the Integrations page of your Settings.

Authentication

The ReadCast API uses oAuth v2 for authentication.

ReadCast expects all API requests to contain a Authorization header with an access token. The authentication header should look like this:

Authorization: Bearer <access token>

User

You can get information on the currently logged in user. It will return user attributes

GET https://readcast.app/api/user

Articles

Get All Articles

You can get a list of your articles, this does not contain the audio information.

`` GET https://readcast.app/api/articles

Save an Article

You can send the URL of an article you want to save. Just send the url parameter in a JSON body, like this:

{
    "url": "https://google.com"
}

`` POST https://readcast.app/api/articles/save

View an article

You can fetch information about a specific article.

GET `https://readcast.app/api/articles/<id>

Regenerate an Article

You can regenerate an article using this endpoint. A body is not required.

POST `https://readcast.app/api/articles/<id>

Delete an Article

You can delete an article using this endpoint. A body is not required.

DELETE `https://readcast.app/api/articles/<id>