Skip to main content
Version: FINAL-1.0.0

Get project

getapi.bunnystudio.com/projects/{id}

This endpoint retrieves information of a project with the Bunny Studio ID.

Requirements​

Authentication
x-access-token
Scope
projects

Path parameters​

id
string
Bunny Studio UUID of the project you want the info

Request example​

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

Response format​

id
string
A UUID (Universal Unique Identifier) that identifies the project on Bunny Studio's database. You should use this ID for all API actions related to a specific project.
title
string
The title of the project you created
mainService
string
The category ID that represent the main service of the project. To check the available categories you can use the Get Categories endpoint or check on Available categories page
fulfillmentType
string
The fulfillment type selected for the project.
Options: speedy, booking, contest
Default: speedy
created
string
The creation date of the project
status
string
The current status of the project
price
number
The price charged for the project
fake
boolean
If the project is fake
Default: false
test
boolean
If the project is a test
Default: false
remarks
string
Additional instructions for the creatives that you submitted when creating the project
services
array_objects
List of services included on the project.
note

Depending on the category of the project, the information related to the services array will vary. Please, check each category below to see more information about them.

Voice Over​

For voice over projects, the mainService will be voice_over.

services
array_objects
List of services included on the project. For Voice over is only one and it should be voice_over
Voice Over
id
string
A UUID (Universal Unique Identifier) that identifies the service on Bunny Studio's database.
subCategory
string
The voice over service ID
price
number
The price charged for the service
status
string
The current status of the service
units
number
Number of words or characters of the script
unitType
string
Type of unit to measure the length of the script. Can be words or characters, depending on the selected language.
language
string
Language required for the service
genderAndAge
string
Gender and age required for the service
purpose
string
Purpose of the voice over, this is a field with a few options that you can choose from, to see the options you can use the Get Attributes Values endpoint
Default: radioTvAds
script
array_object
Array that contains the script that the creative needs to read to fulfill the project

Audio Ads​

For voice over projects, the mainService will be audio_ads.

services
array_objects
List of services included on the project. For Audio ads with script writing it will have script writing, voice over and post-production
Script Writing
id
string
A UUID (Universal Unique Identifier) that identifies the service on Bunny Studio's database.
subCategory
string
The script writing service ID
price
number
The price charged for the service
status
string
The current status of the service
units
number
Number of words or characters of the script writing
unitType
string
Type of unit to measure the length of the service. Can be words or characters, depending on the selected language.
language
string
Language required for the service
voicePerspective
string
From which perspective the script should be written, this is a field with a few options that you can choose from, to see the options you can use the Get Attributes Values endpoint
Default: bunny-pro-choice
topic
string
What is the topic of the script, you can use this field to give more context to the creative
purpose
string
What is the goal or purpose of the script
targetAudience
string
Who is the target audience for the script
keywords
string
Who is the target audience for the script
remarks
string
Additional instructions for the script writing creative
tone
object
The tone of the script, this field is and array of numbers that represents every tone you want to use, if you want to see more info on how the tones works go to Audio ads script writing section
assetsFiles
array
Array that contains the URLs of the attachments that you want to send to the creative
Voice Over
id
string
A UUID (Universal Unique Identifier) that identifies the service on Bunny Studio's database.
subCategory
string
The voice over service ID
price
number
The price charged for the service
status
string
The current status of the service
units
number
Number of words or characters of the script
unitType
string
Type of unit to measure the length of the script. Can be words or characters, depending on the selected language.
language
string
Language required for the service
genderAndAge
string
Gender and age required for the service
purpose
string
Purpose of the voice over, this is a field with a few options that you can choose from, to see the options you can use the Get Attributes Values endpoint
Default: radioTvAds
remarks
string
Additional instructions for the voice over creative
assetsFiles
array
Array that contains the URLs of the attachments that you want to send to the creative
Post production
id
string
A UUID (Universal Unique Identifier) that identifies the service on Bunny Studio's database.
subCategory
string
The post production service ID
price
number
The price charged for the service
status
string
The current status of the service
units
number
Length of the audio file in seconds
unitType
string
Type of unit to measure the length of the script. Can be words or characters, depending on the selected language.
language
string
Language required for the service
backgroundMusic
string
Type of background music required for the service, the options are: audioads-music-library
remarks
string
Additional instructions for the post production creative
trackId
number
The id of the track that you want to use from the music library, you can see the available tracks with the Get Attributes Values endpoint
ownMusicFile
string
The URL of the music file that you want to use for the post production, if you send this field can not send the trackId field
ownMusicFileRights
boolean
The rights of the music file that you want to use for the post production, is required if ownMusicFile is present
proSelectsMusic
boolean
If you want the creative to select the music for the post production
Default: false
assetsFiles
array
Array that contains the URLs of the attachments that you want to send to the creative

Response example​

{
  "id": "74rgd7ba-02e9-4d65-83de-3db4164b298b",
  "title": "28/02 00:00 My First API Project",
  "mainService": "CATEGORY_ID",
  "fulfillmentType": "speedy",
  "created": "2023-03-03T18:17:38",
  "status": "paid",
  "price": 31.00,
  "fake": false,
  "test": true,
  "remarks": "remarks on text",
  "services": [],
}
note

Depending on the category of the project, the information related to the services array will vary. Please, check each category below to see more information about them.

Voice Over​

{
  "services": [{
    "id": "70587623-829c-457c-a605-0b866ff1c6b1",
    "subCategory": "voice_over",
    "price": 31,
    "status": "paid",
    "units": 4,
    "unitType": "words",
    "language": "eng-us",
    "genderAndAge": "middleAgeFemale",
    "purpose": "radioTvAds",
    "script": [{
      "part1": "script script script script",
    }],
}],
}

Audio Ads​

{
  "services": [{
    "id": "70587623-829c-457c-a605-0b866ff1c6b1",
    "subCategory": "scriptwriting",
    "price": 31,
    "status": "paid",
    "units": 75,
    "unitType": "words",
    "language": "eng-us",
    "voicePerspective": "third-person",
    "topic": "For the talking points, we d encourage you to watch the TVC below to get a feel for the vibe of the campaign and what we are all about. Here are a few talking points for them: -Today s coffee world is more fun, more experiential, more flavorful and more diverse than ever before. And Coffee mate is all about it. Coffee mate loves this new wave of coffee experimentation, flavor and fun, and celebrates coffee culture and everything that surrounds it. It doesn t matter how you take your coffee, Coffee mate encourages you to do you",
    "purpose": "Conversion, awareness and spreading the joy and ritual of drinking coffee",
    "targetAudience": "Women ages 25-50",
    "keywords": "Coffee mate. For the love of coffee. Buy now online or in stores.",
    "remarks": "remarks on text for the script writer",
    "tone": {
      "seriousHumorous": -3,
      "conciseWordy": -2,
      "objectiveOpinionated": -5,
      "sincereSarcastic": -3,
      "journalisticCreative": 4,
    },
    "assetsFiles": ["https://www.mywebsite.com/myattachment.pdf"],
},{
    "id": "70587623-829c-457c-a605-0b866ff1c6b1",
    "subCategory": "voice_over",
    "price": 94,
    "status": "paid",
    "units": 30,
    "unitType": "seconds",
    "language": "eng-us",
    "genderAndAge": "middleAgeFemale",
    "purpose": "radioTvAds",
    "remarks": "remarks on text for the voice artist",
    "assetsFiles": ["https://www.mywebsite.com/myattachment.pdf"],
},{
    "id": "70587623-829c-457c-a605-0b866ff1c6b1",
    "subCategory": "post-production",
    "price": 57,
    "status": "paid",
    "units": 30,
    "unitType": "seconds",
    "language": "eng-us",
    "backgroundMusic": "audioads-music-library",
    "remarks": "remarks on text for the post producer",
    "trackId": 80,
    "ownMusicFile": "https://www.mywebsite.com/mymusic.mp3",
    "ownMusicFileRights": true,
    "proSelectsMusic": true,
    "assetsFiles": ["https://www.mywebsite.com/myattachment.pdf"],
}],
}

Error responses​

500 Not project info​

{
  status: 500,
  type: 'NOT_PROJECT_INFO',
  message: 'There was an error getting Project with id "PROJECT_ID" info, please talk with our support team',
}

404 Project not exist​

{
  status: 404,
  type: 'PROJECT_NO_EXIST',
  message: 'Project with id "PROJECT_ID" not found',
}

403 Forbidden​

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