To use the Article API, perform a POST request to the following URL:
All requests must be authenticated with your API key using a Bearer token:
Authorization: Bearer YOUR_API_KEY
Each successful Article API call uses 1 credit.
Send a JSON body with the following parameters:
| Parameter | Type | Description |
|---|---|---|
url |
string | URL of the article to parse. |
content |
string | (Optional) Raw HTML content to parse instead of fetching from url. |
output |
string | (Optional) Output format. Either "html" (default) or "text". |
use_cache |
bool | (Optional) Specify if use of cache is permitted. Defaults to true. If set to the string "false", the cache is bypassed. |
On success, returns a JSON dictionary containing the following keys:
| Key | Description |
|---|---|
url |
Canonical URL |
title |
Title |
site_name |
Website Name |
thumbnail |
Thumbnail Image |
description |
Article description |
author |
Author's Name |
date |
Published date (UNIX time) |
html |
HTML with body of article (present when output is "html") |
text |
Plain text body of article (present when output is "text") |
words |
Number of words in the article |
is_rtl |
true if Arabic or Hebrew, otherwise false |
images |
List of images in the article |
videos |
List of embedded videos in article |
Possible status codes:
| Code | Reason |
|---|---|
| 200 | Success |
| 400 | Parameter missing or malformed |
| 401 | API key is invalid |
| 403 | Account suspended (payment error) |
| 409 | Exceeded monthly calls (Trial plan only) |
| 412 | Upstream parsing error or invalid response from parser |
| 429 | Rate limit exceeded |