📰Articles

Creating a new article

Create article.

POST https://bottalk.io/api/articles

Creates a new audio article inside of a project.

Request Body

NameTypeDescription

title*

string

The title of the article

text*

string

The main content of the article.

url*

string

The page url of the original article

parse

boolean

Should BotTalk parse HTML inside of the article?

labels

array

Labels to assign to the article inside BotTalk.

externalId

string|null

uniq id for external control, this field in uniq, and if already exists we will answer by 400 http status code.

voice

String

The voice from list for audify article

lang

String

The language from list for audify article

{
  "result": "ok",
  "id": "b49f2511d9033f313b8c0d361687cd5f"
}

Retrieving an aritcle by external_id

Fetch article.

GET https://bottalk.io/api/articles_external_id/{external_id}

response same as for retrieve an article method

Retrieving an aritcle

Fetch article.

GET https://bottalk.io/api/articles/{id}

Fetches an article by id

{
  "result": "ok",
  "article": {
    "id": "90ae27149dba7f5fbf4269b9318ba9cb",
    "externalId": "321654",
    "title": "Test title 5",
    "text": "Test text 09",
    "added": 1573133305,
    "status": "ready",
    "voice": "de-DE-ConradNeural",
    "lang": "de-DE",
    "url": "https://test.de/article.html",     
    "type": [
                 {
                   "Name": "TYPE_NACHRICHT",
                   "Score": 0.20319999754428864
                 },
                 {
                   "Name": "TYPE_KOMMENTAR",
                   "Score": 0.14839999377727509
                 },
                 {
                   "Name": "TYPE_LIVE_TICKER",
                   "Score": 0.12219999730587006
                 }
           ],
    "audio": "https:\/\/bottalk.io\/audio\/d67e6dd172ab320880a158fd17fcf4f4.mp3"
  }
}

Retrieving multiple articles

Fetch multiple articles.

GET https://bottalk.io/api/articles?limit={n}&offset={m}

Fetches articles from the project.

Query Parameters

NameTypeDescription

limit

integer

Number of articles to retrieve

offset

integer

Offset of the results if they are limited

{
  "result": "ok",
  "article": {
    "id": "90ae27149dba7f5fbf4269b9318ba9cb",
    "title": "Test title 5",
    "text": "Test text 09",
    "added": 1573133305,
    "status": "ready",
    "url": "https://test.de/article.html",     
    "type": [
                 {
                   "Name": "TYPE_NACHRICHT",
                   "Score": 0.20319999754428864
                 },
                 {
                   "Name": "TYPE_KOMMENTAR",
                   "Score": 0.14839999377727509
                 },
                 {
                   "Name": "TYPE_LIVE_TICKER",
                   "Score": 0.12219999730587006
                 }
           ],
    "audio": "https:\/\/bottalk.io\/audio\/d67e6dd172ab320880a158fd17fcf4f4.mp3"
  }
}

Updating an article

Update article.

PUT https://bottalk.io/api/articles/{id}

Updates a audio article.

Request Body

NameTypeDescription

title*

string

The title of the article

text*

string

The main content of the article.

url*

string

The page url of the original article

labels

array

Labels to assign to the article inside BotTalk.

parse

boolean

Should BotTalk parse HTML inside of the article?

voice

String

Voice "de-DE-ConradNeural"

lang

String

de-DE,en-US, language

{
  "result": "ok",
  "id": "b49f2511d9033f313b8c0d361687cd5f"
}

Updating an article by external id

Update article by external_id

PUT https://bottalk.io/api/articles_external_id/{external_id}

Updates an audio article.

All params and responses same as for Update Article /api/articles/{id}

Deleting an article

Delete an article.

DELETE https://bottalk.io/api/articles/{id}

Deletes an article from the project.

{
  "result": "ok"
}

Article Status

statusdescription

ready

the article is ready and audiofile exists

processing

the audification is in progress

waiting

the article is waiting to be audified

rejected

the article is rejected by audio automation rules

errored

the article contains an error which prevented audification

Voice and Language fields

example: {"voice":"de-DE-ConradNeural", "lang":"de-DE"}

VoiceLang (list separated by comma, you can choose one of them)

echo

de-DE,en-US

fable

de-DE,en-US

alloy

de-DE,en-US

onyx

de-DE,en-US

nova

de-DE,en-US

shimmer

de-DE,en-US

de-DE-ConradNeural

de-DE

de-DE-KatjaNeural

de-DE

Last updated