Developers

Simple HTTP API

We provide two API endpoints: POST /articles and GET /articles/:id.
Requests to both requests are authenticated via the x-api-key header that you will be provided.

POST /articles

url: url of the article to be converted
html: html content of the article (optional)
title: title of the article
voice: voice to use for the conversion
callback: callback information (optional)

url: url where the processing updates will be sent
x_callback_key: a secret key to authenticate callback requests, generated by you and sent in headers

A callback URL will receive the same JSON response structure.

// ->> request
{
  "url": "https://website.com/blog/article-slug",
  "html": "<p>Article content</p>",
  "title": "Article title",
  "voice": "female",
  "callback": {
    "url": "https://website.com/api/article2audio-updates",
    "x_callback_key": "your secret key"
  }
}

// <<- response
{
  "id": "66f572166ec571d315eaae54",
  "status": "Processing"
}

GET /articles/:id

You can use the ID to poll the status of the article conversion. Or subscribe to the callback URL to receive updates when the conversion is finished.

// <<- response
{
  "id": "66f572166ec571d315eaae54",
  "status": "Ready",
  "audio_url": "https://article2audio.app/a/66f572166ec571d315eaae54.mp3"
}

Request Access

Please submit the form below and I will get back to you with the details on how you can integrate with article2audio on your website.
Oleksandr, creator of article2audio