API (Legacy)

Projects

Audio API

PreviousMembers NextPlayer SDK (Legacy)

Last updated 1 year ago

List

Retrieve a list of projects

get

/api/v4/projects

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://app.beyondwords.io/api/v4/projects' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

401

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

Create

Create a new Audio asset

post

/api/v4/projects/{project_id}/audio

Authorizations

Path parameters

project_idstringrequired

ID of Project

Body

bodystringrequired

Main content of your audio. 100000 characters limit

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

titlestringrequired

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").

publishedboolean | nullable

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

image_urlstring | nullable

The feature image URL of the content

metadataobject

A custom object for storing meta information

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://app.beyondwords.io/api/v4/projects/{project_id}/audio' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"body":"This is a sample text for your audio. This field has a 100000 characters limit.","title":"Sample short title","author":"some author of your audio","metadata":{"key":"value"}}'

200

401

404

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

Fetch

Fetch an Audio asset by ID

get

/api/v4/projects/{project_id}/audio/{id}

Authorizations

Path parameters

project_idstringrequired

ID of Project

idstringrequired

ID of Audio asset

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://app.beyondwords.io/api/v4/projects/{project_id}/audio/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

401

404

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

Delete

Delete an Audio asset by ID

delete

/api/v4/projects/{project_id}/audio/{id}

Authorizations

Path parameters

project_idstringrequired

ID of Project

idstringrequired

ID of Audio asset

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://app.beyondwords.io/api/v4/projects/{project_id}/audio/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

401

404

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

Update

Update an Audio asset by ID

patch

/api/v4/projects/{project_id}/audio/{id}

Authorizations

Path parameters

project_idstringrequired

ID of Project

idstringrequired

ID of Audio asset

Body

bodystringrequired

Main content of your audio. 100000 characters limit

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

titlestringrequired

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").

publishedboolean | nullable

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

image_urlstring | nullable

The feature image URL of the content

metadataobject

A custom object for storing meta information

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://app.beyondwords.io/api/v4/projects/{project_id}/audio/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"body":"This is a sample text for your audio. This field has a 100000 characters limit.","title":"Sample short title","author":"some author of your audio","metadata":{"key":"value"}}'

200

401

404

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

List

Retrieve a list of Audio assets

get

/api/v4/projects/{project_id}/audio

Authorizations

Path parameters

project_idstringrequired

ID of Project

Query parameters

pageinteger

Number of page of Audio assets list, 50 elements per page

periodstring · enum

Time range

Options: daily, weekly

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://app.beyondwords.io/api/v4/projects/{project_id}/audio' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

401

404

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