API (Legacy)

Projects

List

Retrieve a list of projects

GEThttps://app.beyondwords.io/api/v4/projects

Authorization

Response

Body

idinteger

ID of your project

titlestring

The title of your project

typeenum

The type of your project

documentsapiwordpressrss

languagestring

The language code in ISO 639-1

urlnullable string

The site url of your project

title_voicestring

The sub voice name for titles

body_voicestring

The main voice name

audio_countinteger

The number of created audio

image_urlnullable string

Link to the image specified in player distribution

Request

const response = await fetch('https://app.beyondwords.io/api/v4/projects', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

[
  {
    "title": "text",
    "type": "documents",
    "language": "text",
    "url": "text",
    "title_voice": "text",
    "body_voice": "text",
    "image_url": "text"
  }
]

Audio API

List

Retrieve a list of Audio assets

GEThttps://app.beyondwords.io/api/v4/projects/{project_id}/audio

Authorization

Path parameters

project_id*string

ID of Project

Query parameters

Response

Body

idinteger

ID of your audio

external_idstring

Your own internal ID

stateenum

Current processing status

unprocessedprocessederrorprocessedscheduledskipped

mediaarray of mediaModel (object)

Media objects of your audio

image_urlnullable string

Link to the article's image

deletedboolean

Is your audio deleted or not

access_keynullable string

An access key for fetching scheduled articles

processing_atnullable string

publishednullable boolean

Whether the audio is published or not. The default is true.

metadataobject

Request

const response = await fetch('https://app.beyondwords.io/api/v4/projects/{project_id}/audio', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

[
  {
    "external_id": "text",
    "state": "unprocessed",
    "media": [
      {
        "content_type": "text",
        "url": "text",
        "duration": 0
      }
    ],
    "image_url": "text",
    "deleted": false,
    "access_key": "text",
    "processing_at": "text",
    "published": false,
    "metadata": {
      "key": "value"
    }
  }
]

Create

Create a new Audio asset

POSThttps://app.beyondwords.io/api/v4/projects/{project_id}/audio

Authorization

Path parameters

project_id*string

ID of Project

Body

body*string

Main content of your audio. 100000 characters limit

Example: "This is a sample text for your audio. This field has a 100000 characters limit."

title*string

Header content of your audio

Example: "Sample short title"

external_idstring

Your own internal ID

authorstring

Author of the article

Example: "some author of your audio"

article_urlstring

Page url where this article was placed

publish_datestring (data-time)

Published at date and time in UTC, formatted as ISO 8601 string (e.g. "2021-10-04T12:04:44Z").

publishednullable boolean

Whether the audio is published or not. The default is true.

image_urlnullable string

The feature image URL of the content

metadataobject

A custom object for storing meta information

Response

Body

idinteger

ID of your audio

external_idstring

Your own internal ID

stateenum

Current processing status

unprocessedprocessederrorprocessedscheduledskipped

mediaarray of mediaModel (object)

Media objects of your audio

image_urlnullable string

Link to the article's image

deletedboolean

Is your audio deleted or not

access_keynullable string

An access key for fetching scheduled articles

processing_atnullable string

publishednullable boolean

Whether the audio is published or not. The default is true.

metadataobject

Request

const response = await fetch('https://app.beyondwords.io/api/v4/projects/{project_id}/audio', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "title": "Sample short title",
      "body": "This is a sample text for your audio. This field has a 100000 characters limit."
    }),
});
const data = await response.json();

Response

{
  "external_id": "text",
  "state": "unprocessed",
  "media": [
    {
      "content_type": "text",
      "url": "text",
      "duration": 0
    }
  ],
  "image_url": "text",
  "deleted": false,
  "access_key": "text",
  "processing_at": "text",
  "published": false,
  "metadata": {
    "key": "value"
  }
}

Fetch

Fetch an Audio asset by ID

GEThttps://app.beyondwords.io/api/v4/projects/{project_id}/audio/{id}

Authorization

Path parameters

project_id*string

ID of Project

id*string

ID of Audio asset

Response

Body

idinteger

ID of your audio

external_idstring

Your own internal ID

stateenum

Current processing status

unprocessedprocessederrorprocessedscheduledskipped

mediaarray of mediaModel (object)

Media objects of your audio

image_urlnullable string

Link to the article's image

deletedboolean

Is your audio deleted or not

access_keynullable string

An access key for fetching scheduled articles

processing_atnullable string

publishednullable boolean

Whether the audio is published or not. The default is true.

metadataobject

Request

const response = await fetch('https://app.beyondwords.io/api/v4/projects/{project_id}/audio/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "external_id": "text",
  "state": "unprocessed",
  "media": [
    {
      "content_type": "text",
      "url": "text",
      "duration": 0
    }
  ],
  "image_url": "text",
  "deleted": false,
  "access_key": "text",
  "processing_at": "text",
  "published": false,
  "metadata": {
    "key": "value"
  }
}

Delete

Delete an Audio asset by ID

DELETEhttps://app.beyondwords.io/api/v4/projects/{project_id}/audio/{id}

Authorization

Path parameters

project_id*string

ID of Project

id*string

ID of Audio asset

Response

Body

idinteger

ID of your audio

external_idstring

Your own internal ID

stateenum

Current processing status

unprocessedprocessederrorprocessedscheduledskipped

mediaarray of mediaModel (object)

Media objects of your audio

image_urlnullable string

Link to the article's image

deletedboolean

Is your audio deleted or not

access_keynullable string

An access key for fetching scheduled articles

processing_atnullable string

publishednullable boolean

Whether the audio is published or not. The default is true.

metadataobject

Request

const response = await fetch('https://app.beyondwords.io/api/v4/projects/{project_id}/audio/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "external_id": "text",
  "state": "unprocessed",
  "media": [
    {
      "content_type": "text",
      "url": "text",
      "duration": 0
    }
  ],
  "image_url": "text",
  "deleted": false,
  "access_key": "text",
  "processing_at": "text",
  "published": false,
  "metadata": {
    "key": "value"
  }
}

Update

Update an Audio asset by ID

PATCHhttps://app.beyondwords.io/api/v4/projects/{project_id}/audio/{id}

Authorization

Path parameters

project_id*string

ID of Project

id*string

ID of Audio asset

Body

body*string

Main content of your audio. 100000 characters limit

Example: "This is a sample text for your audio. This field has a 100000 characters limit."

title*string

Header content of your audio

Example: "Sample short title"

external_idstring

Your own internal ID

authorstring

Author of the article

Example: "some author of your audio"

article_urlstring

Page url where this article was placed

publish_datestring (data-time)

Published at date and time in UTC, formatted as ISO 8601 string (e.g. "2021-10-04T12:04:44Z").

publishednullable boolean

Whether the audio is published or not. The default is true.

image_urlnullable string

The feature image URL of the content

metadataobject

A custom object for storing meta information

Response

Body

idinteger

ID of your audio

external_idstring

Your own internal ID

stateenum

Current processing status

unprocessedprocessederrorprocessedscheduledskipped

mediaarray of mediaModel (object)

Media objects of your audio

image_urlnullable string

Link to the article's image

deletedboolean

Is your audio deleted or not

access_keynullable string

An access key for fetching scheduled articles

processing_atnullable string

publishednullable boolean

Whether the audio is published or not. The default is true.

metadataobject

Request

const response = await fetch('https://app.beyondwords.io/api/v4/projects/{project_id}/audio/{id}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "title": "Sample short title",
      "body": "This is a sample text for your audio. This field has a 100000 characters limit."
    }),
});
const data = await response.json();

Response

{
  "external_id": "text",
  "state": "unprocessed",
  "media": [
    {
      "content_type": "text",
      "url": "text",
      "duration": 0
    }
  ],
  "image_url": "text",
  "deleted": false,
  "access_key": "text",
  "processing_at": "text",
  "published": false,
  "metadata": {
    "key": "value"
  }
}

PreviousMembers NextPlayer SDK (Legacy)

Last updated 1 year ago

const response = await fetch('https://app.beyondwords.io/api/v4/projects/{project_id}/audio/{id}', { method: 'PATCH', headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" }, body: JSON.stringify({ "title": "Sample short title", "body": "This is a sample text for your audio. This field has a 100000 characters limit." }), }); const data = await response.json();

{ "external_id": "text", "state": "unprocessed", "media": [ { "content_type": "text", "url": "text", "duration": 0 } ], "image_url": "text", "deleted": false, "access_key": "text", "processing_at": "text", "published": false, "metadata": { "key": "value" } }

const response = await fetch('https://app.beyondwords.io/api/v4/projects/{project_id}/audio', { method: 'POST', headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" }, body: JSON.stringify({ "title": "Sample short title", "body": "This is a sample text for your audio. This field has a 100000 characters limit." }), }); const data = await response.json();