Articles

Reference API for interacting with a users articles.

Articles can exist in three states:

Transcribing	Processing	Completed
The article is currently being transcribed by our web crawlers.	The article has been transcribed and is being processed by our speech synthesizer.	The article has been completed and is ready to be listened to.

List Articles

GET https://www.frequencyapp.com/api/v1/articles/

Get a list of all your saved articles.

Query Parameters

Name	Type	Description
page	string	A page number if there are more than 50 articles to request. Defaults to 1.

200 Returns a list of article objects.

{
    "object": "List",
    "page": "1",
    "url": "/api/v1/articles",
    "data": [
        {
            "object": "Article",
            "id": "1",
            "title": "My Article Title",
            "status": "Completed",
            "transcript": {
                "object": "Transcript",
                "id": "1",
                "text": "..."
            }
        }
    ]
}

404 Could not find an article matching this query.

{
    "message": "Record could not be found."
}

Get Article

GET https://www.frequencyapp.com/api/v1/articles/:id

Get information on a specific article. If completed it will also show a transcript object which contains the text of the article that is spoken.

Path Parameters

Name	Type	Description
id	string	The ID of the article.

200 Returns an article, either with or without a transcript depending on its state.

{
    "object": "Article",
    "id": "1",
    "title": "My Article Title"
    "link": "https://mylink.com",
    "status": "Completed",
    "transcript": {
        "object": "Transcript",
        "id": "1",
        "text": "..."
    }
}

// Or if the article is still transcribing,
// it will return a empty string:

{
    "object": "Article",
    "id": "1",
    "title": "My Article Title"
    "link": "https://mylink.com",
    "status": "Transcribing",
    "transcript": ""
}

Create Article

POST https://www.frequencyapp.com/api/v1/articles

Add an article to the users library. Titles on articles are scraped from their content and do not need to be set manually.

Request Body

Name	Type	Description
link	string	The publicly available URL link to the article.

201

{
    "object": "Article",
    "id": "1",
    "title": "https://mylink.com"
    "link": "https://mylink.com",
    "status": "Transcribing",
    "transcript": ""
}

Remove Article

DELETE https://www.frequencyapp.com/api/v1/articles/:id

Removes an article from the users library.

200 Destroys the article from the users library.

{
    "object": "Article",
    "id": "1",
    "status": "Removed"
}