Get project - Docs and guides

GET

/

projects

/

{id}

Get project

curl --request GET \
  --url https://api.beyondwords.io/v1/projects/{id} \
  --header 'X-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://api.beyondwords.io/v1/projects/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.beyondwords.io/v1/projects/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.beyondwords.io/v1/projects/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.beyondwords.io/v1/projects/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": 1,
  "name": "My project",
  "description": "A daily news podcast covering local politics.",
  "language": "en_US",
  "auto_publish_enabled": true,
  "avatar_url": "https://example.com/avatar.jpg",
  "environment": "production",
  "created": "2022-01-02 23:59:59 UTC",
  "updated": "2022-03-04 00:00:00 UTC"
}

Authorizations

X-Api-Key

string

header

required

Path Parameters

id

string

required

project id

Response

200 - application/json

successful

id

integer

Unique identifier for the object

name

string

The project name

description

string | null

A short description of the publication, used by the AI agent and AI assistant surfaces.

Maximum string length: 1000

language

string

The default language of the project (ISO 639-1 code with optional region, e.g., en_GB)

Pattern: ^[a-z]{2}(_[A-Z]{2})?$

language_data

object

Additional language metadata for the project

environment

enum<string> | null

Available options:

production,

staging

logo_color

string | null

content_total_count

integer

content_updated

string<date-time> | null

title

object

Show child attributes

summary

object | null

Show child attributes

body

object

Show child attributes

background_track

object | null

Show child attributes

auto_publish_enabled

boolean

When true, automatically distribute content once generated (default is true)

auto_video_publish_enabled

boolean

When true, automatically distribute video content once generated (default is true)

time_zone

string

The project time zone (IANA time zone name)

avatar_url

string<uri> | null

The project's avatar URL

Maximum string length: 2048

pause_after_title_segments_seconds

number

Required range: 0 <= x <= 3

pause_after_segments_seconds

number

Required range: 0 <= x <= 3

created

string<date-time>

Time at which the object was created (ISO 8601)

updated

string<date-time>

Time at which the object was updated (ISO 8601)

Get project

curl --request GET \
  --url https://api.beyondwords.io/v1/projects/{id} \
  --header 'X-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://api.beyondwords.io/v1/projects/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.beyondwords.io/v1/projects/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.beyondwords.io/v1/projects/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.beyondwords.io/v1/projects/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": 1,
  "name": "My project",
  "description": "A daily news podcast covering local politics.",
  "language": "en_US",
  "auto_publish_enabled": true,
  "avatar_url": "https://example.com/avatar.jpg",
  "environment": "production",
  "created": "2022-01-02 23:59:59 UTC",
  "updated": "2022-03-04 00:00:00 UTC"
}