Get single deliverable

getapi.bunnystudio.com/deliverables/{id}

This endpoint retrieves the information of a single deliverable by ID.

Requirements

Authentication

x-access-token

Scope

deliverables

Path parameters

id

string
Bunny Studio UUID of the deliverable you want the information

Request example

Console

 curl --request GET \ 
      --url https://api.bunnystudio.com/deliverables/DELIVERABLE_ID \
      --header "x-access-token: YOUR_TOKEN" \

JavaScript

  const url = 'https://api.bunnystudio.com/deliverables/DELIVERABLE_ID';
  const options = {
    method: 'GET',
    headers: {
      'x-access-token': 'YOUR_TOKEN',
    }
  }; 
  fetch(url, options)
    .then(response => response.json())
    .then(response => console.log(response))
    .catch(err => console.error(err));

Python

  import requests
  import json
  api_url = "https://api.bunnystudio.com/deliverables/DELIVERABLE_ID"
  headers = {
    'x-access-token': 'YOUR_TOKEN',
  }
  response = requests.get(api_url, headers=headers)
  print(response.text)

PHP - CURL

<?php
  $curl = curl_init();
  curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://api.bunnystudio.com/deliverables/DELIVERABLE_ID',
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => array(
      'x-access-token': 'YOUR_TOKEN',
    ),
    
  ));
  $response = curl_exec($curl);
  curl_close($curl);
  echo $response;

Reponse format

id

string
A UUID (Universal Unique Identifier) that identifies the deliverable on Bunny Studio's database. You should use this ID for all API actions related to a specific deliverable.

serviceSubCategory

string
The category of this deliverable

name

string
The name of the deliverable.

status

string
The status of the deliverable

urls

object
The URLs of the files from the deliverable.

note

Depending on the category of the deliverable, the information related to the URLs array will change. Please, check each category on the response example to see more information about them.

Reponse example

Voice Over

The URLs of the files for voice over will be .mp3 and .wav files

{
  "id": "671e74ab-ca44-4d87-9346-ae8318c44774",
  "serviceSubCategory": "voice_over",
  "name": "part1",
  "status": "reviewable",
  "urls": {
    "wav": "https://.../..../part1.wav",
    "mp3": "https://.../....//part1.mp3",
  },
}

Audio Ads

Script writing

The URLs of the files for scriptwriting will be .pdf and .content files

{
  "id": "53f6e5c7-e2b8-446c-979f-1cfb6331c640",
  "serviceSubCategory": "scriptwriting",
  "name": "Script",
  "status": "reviewable",
  "urls": {
    "pdf": "https://.../..../Script.pdf",
    "content": "Discover the vibrant world of coffee with Coffee mate. Today’s coffee scene is an exciting journey of flavor and enjoyment, and Coffee mate fully embraces this culture. It doesn’t matter how you take your coffee; for the love of coffee, Coffee mate encourages you to enjoy every sip. Buy now online or in stores to experience the fun and diversity that awaits!",
  },
}

Voice

The URLs of the files for voice over will be .mp3 and .wav files

{
  "id": "671e74ab-ca44-4d87-9346-ae8318c44774",
  "serviceSubCategory": "voice_over",
  "name": "part1",
  "status": "reviewable",
  "urls": {
    "wav": "https://.../..../part1.wav",
    "mp3": "https://.../....//part1.mp3",
  },
}

Post production

The URLs of the files for post-production will be .mp3 and .wav files

{
  "id": "27ead156-260c-4c0d-8e4b-231de16b4fb6",
  "serviceSubCategory": "post-production",
  "name": "Post-produced audio Part 1",
  "status": "reviewable",
  "urls": {
    "wav": "https://.../..../Post-produced%20audio%20Part%201.wav",
    "mp3": "https://.../....//Post-produced%20audio%20Part%201.mp3",
  },
}

Error responses

500 Error getting deliverable

  {
    status: 500,
    type: 'ERROR_GETTING_DELIVERABLE',
    message: 'There was an error getting the deliverable with id \"DELIVERABLE_ID\", please talk with out support team',
  }

400 Deliverable not exist

  {
    status: 404,
    type: 'DELIVERABLE_NO_EXIST',
    message: 'Deliverable with id \"DELIVERABLE_ID\" not found',
  }

403 Forbidden

  {
    status: 403,
    type: 'FORBIDDEN',
    message: 'You do not have permission to do this action',
  }

422 Id required

  {
    status: 422,
    type: 'ID_REQUIRED',
    message: 'The field "\id\" is required',
  }