POST
/
get_article
curl --request POST \
  --url https://api.byword.ai/get_article \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "<string>",
  "articleID": "<string>"
}'

This endpoint allows you to retrieve articles created via Create Article. Articles typically take around 60 seconds to generate, so it’s recommended to call this API at 5 second intervals until the endpoint returns a response with all of the article’s fields.

​
Request

​
key
string
required

Your Byword API key. Can be found here.

​
articleID
string
required

The ID of the article that was returned from the Create Article endpoint.

​
Response

The response will contain all of the article’s fields when ready. While the article is still generating, you may receive a partial response.

​
Examples

​
Request Example

{
  "key": "your_api_key_here",
  "articleID": "1234567890abcdef"
}

​
Success Response

{
  "status": "complete",
  "title": "Sample Article Title",
  "content": "The full article content...",
  "wordCount": 1500,
  "language": "English",
  "createdAt": "2025-03-25T12:34:56Z"
}

​
Processing Response

{
  "status": "processing",
  "message": "Your article is still being generated. Please try again in a few seconds."
}

​
Implementation Notes

  • Articles typically take around 60-120 seconds to generate, but this can vary based on length and complexity.
  • It’s recommended to poll this endpoint at 5-second intervals until you receive a complete response.
  • Consider implementing an exponential backoff strategy for production applications.

Was this page helpful?