POST
/
projects
curl --request POST \
  --url https://api.beyondwords.io/v1/projects \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '{
  "name": "My project",
  "language": "en_US"
}'
{
  "id": 1,
  "name": "My project",
  "language": "en_US",
  "auto_publish_enabled": true,
  "avatar_url": "https://example.com/avatar.jpg",
  "created": "2022-01-02 23:59:59 UTC",
  "updated": "2022-03-04 00:00:00 UTC"
}

Authorizations

​
X-Api-Key
string
header
required

Body

application/json
​
name
string
required

The project name

​
language
object
required
​
title
object
​
summary
object
​
body
object
​
background_track
object | null
​
auto_publish_enabled
boolean

Whether or not the content should be automatically distributed once it has been generated. The default is true

​
avatar_url
string

The project's avatar url

​
time_zone
string

Response

200 - application/json
successful
​
id
integer

Unique identifier for the object

​
name
string

The project name

​
language
string

The default language of the project

​
language_data
object

The default language data of the project

​
title
object
​
summary
object | null
​
body
object
​
background_track
object | null
​
auto_publish_enabled
boolean

Whether or not the content should be automatically distributed once it has been generated The default is true.

​
time_zone
string

The project time zone

​
avatar_url
string | null

The project's avatar url

​
created
string

Time at which the object was created (ISO 8601)

​
updated
string

Time at which the object was updated (ISO 8601)

Previous
Get project
Next