Beautiful galleries deserve the right mix of music for the occasion, and ShootProof has partnered with Triple Scoop Music to help studios set the right tone for their brands and events.
Through the ShootProof API, you can help studios manage their music playlists, as well as access the studio’s music streams from your app.
Returns a list of all music plans available for the current studio.
/studio/plan/musicWe’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| Authentication required |
The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens. |
200 OKMusic plan list response.
When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| items |
A collection of resources returned in the current result set.
|
||||||||||||||||||||||||||
| links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name. |
||||||||||||||||||||||||||
| meta read-only |
Metadata describing the current result set.
|
||||||||||||||||||||||||||
| type |
The model type for the list response object. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"200": {
"content": {
"application/vnd.shootproof+json": {
"schema": {
"allOf": [
{
"description": "A collection of music plans available for the studio.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Studio/properties/musicPlan"
},
"title": "Music Plan",
"type": "array"
},
"type": {
"description": "The model type for the list response object.",
"enum": [
"studio-music-plan-collection"
],
"type": "string"
}
}
},
{
"$ref": "#/components/schemas/List"
}
]
}
}
},
"description": "Music plan list response."
}
}Returns a list of all music playlists for the studio. Playlists are shared across all brands in the studio.
Query string parameters may be used to affect the response, including pagination, sorting, and filtering.
/studio/playlistWe’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| Authentication required |
The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens. |
200 OKMusic playlists list response.
When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| items |
An array of music playlists.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| meta read-only |
Metadata describing the current result set.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type |
The type of object represented. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"200": {
"content": {
"application/vnd.shootproof+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/List"
},
{
"properties": {
"items": {
"description": "An array of music playlists.",
"items": {
"description": "A studio music playlist.",
"properties": {
"created": {
"description": "The creation date of this playlist.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"id": {
"allOf": [
{
"$ref": "#/components/schemas/Id"
},
{
"readOnly": true
}
]
},
"isEditable": {
"description": "Flag indicating whether the playlist is editable by the studio. Playlists created by the studio have a\ntrue value here, playlists created by the system (ie: featured playlists) are false. If this value is false,\nthe playlist can be neither edited or deleted by the studio via the API.",
"readOnly": true,
"type": "boolean"
},
"name": {
"description": "The playlist name.",
"type": "string"
},
"songCount": {
"description": "The number of songs appearing in the playlist.",
"readOnly": true,
"type": "integer"
},
"type": {
"description": "The type of object represented.",
"enum": [
"playlist"
],
"type": "string"
}
},
"required": [
"type",
"name"
],
"title": "A music playlist.",
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"type": {
"description": "The type of object represented.",
"enum": [
"playlist-collection"
],
"type": "string"
}
},
"type": "object"
}
],
"description": "A collection of music playlists."
}
}
},
"description": "Music playlists list response."
}
}Creates a new music playlists for the studio. Playlists are shared across all brands in the studio.
The songs will be ordered in the playlist according to their order in the songs request property.
/studio/playlistWe’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| Authentication required |
The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens. |
The playlist.
| Property | Description | ||||||
|---|---|---|---|---|---|---|---|
| name |
The playlist name. |
||||||
| songs |
The songs in the playlist, represented by their ID. The Ultimate music plan supports addition of up to 20 songs in a playlist. The limited music plans support addition of 3 songs in a playlist. Submitting more songs than the subscribed plan supports will result in a 400 with validation errors.
|
||||||
| type |
The type of object represented. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"content": {
"application/vnd.shootproof+json": {
"schema": {
"$ref": "#/components/schemas/Playlist"
}
}
},
"description": "The playlist.",
"required": true
}200 OKMusic playlist response.
When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.
| Property | Description | ||||||
|---|---|---|---|---|---|---|---|
| created read-only |
The creation date of this playlist. |
||||||
| id read-only |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||
| isEditable read-only |
Flag indicating whether the playlist is editable by the studio. Playlists created by the studio have a true value here, playlists created by the system (ie: featured playlists) are false. If this value is true, the playlist can be neither edited or deleted by the studio via the API. If this value is false, submitting an update to this playlist will result in a 400 with validation errors. |
||||||
| name |
The playlist name. |
||||||
| songCount read-only |
The number of songs appearing in the playlist. |
||||||
| songs |
The songs in the playlist, represented by their ID. The Ultimate music plan supports addition of up to 20 songs in a playlist. The limited music plans support addition of 3 songs in a playlist. Submitting more songs than the subscribed plan supports will result in a 400 with validation errors.
|
||||||
| type |
The type of object represented. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"200": {
"content": {
"application/vnd.shootproof+json": {
"schema": {
"$ref": "#/components/schemas/Playlist"
}
}
},
"description": "Music playlist response."
}
}Deletes a Playlist with the given ID. If the ID is not found, returns a 404 response.
/studio/playlist/{playlistId}We’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| playlistId required |
The playlist identifier. |
| Property | Description |
|---|---|
| Authentication required |
The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens. |
204 No ContentSuccessful deletion response.
400 Bad RequestValidation error response. Check the info.errors property in the response for more details.
When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| detail |
A longer description of of the error encountered. |
||||||||||||||
| info |
Additional information that may be provided to aid in error resolution.
|
||||||||||||||
| status |
The HTTP status code associated with this error. |
||||||||||||||
| title |
A short description of the error encountered. |
||||||||||||||
| type |
A namespace URI uniquely identifying the error type. |
API errors come in two kinds of varieties: 400s and 500s.
Any error with a status code of 400 to 499 is considered a client error. This means it’s usually an error you can handle in your app, and then resend a modified request to the ShootProof API to get a successful response.
An error in the range of 500 to 599, on the other hand, is a different story. These errors usually mean that a problem occured on the server and resending the request with modifications will not fix the issue.
Pay careful attention to the status codes. We try to stick as close as possible to their defined semantics. For a complete list of HTTP status codes, take a look at the official HTTP Status Code Registry.
Check out our errors guide for more information.
When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| detail |
A longer description of of the error encountered. |
||||||||||||
| info |
Additional information that may be provided to aid in error resolution.
|
||||||||||||
| status |
The HTTP status code associated with this error. |
||||||||||||
| title |
A short description of the error encountered. |
||||||||||||
| type |
A namespace URI uniquely identifying the error type. |
{
"detail": "There was a problem with your request. Please see `info` for more information.",
"info": {
"errors": {
"type": {
"isEmpty": "Value is required and can't be empty"
}
}
},
"status": 400,
"title": "Bad Request",
"type": "https://developer.shootproof.com/errors#error-bad-request"
}{
"detail": "You do not have permission to access the requested resource.",
"status": 403,
"title": "Forbidden",
"type": "https://developer.shootproof.com/errors#error-forbidden"
}{
"detail": "The requested resource could not be found.",
"status": 404,
"title": "Not Found",
"type": "https://developer.shootproof.com/errors#error-not-found"
}{
"detail": "An error occurred on the server. If this error continues to occur, please contact support.",
"status": 500,
"title": "Internal Server Error",
"type": "https://developer.shootproof.com/errors#error-server-error"
}{
"detail": "No authorization credentials provided. You must provide an authorization token for this request.",
"status": 401,
"title": "Unauthorized",
"type": "https://developer.shootproof.com/errors#error-unauthorized"
}The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"204": {
"description": "Successful deletion response."
},
"400": {
"$ref": "#/components/responses/validationError"
},
"default": {
"$ref": "#/components/responses/defaultError"
}
}Returns a Playlist with the given ID. If the ID is not found, returns a 404 response.
/studio/playlist/{playlistId}We’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| playlistId required |
The playlist identifier. |
| Property | Description |
|---|---|
| Authentication required |
The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens. |
200 OKA Playlist
When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.
| Property | Description | ||||||
|---|---|---|---|---|---|---|---|
| created read-only |
The creation date of this playlist. |
||||||
| id read-only |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||
| isEditable read-only |
Flag indicating whether the playlist is editable by the studio. Playlists created by the studio have a true value here, playlists created by the system (ie: featured playlists) are false. If this value is true, the playlist can be neither edited or deleted by the studio via the API. If this value is false, submitting an update to this playlist will result in a 400 with validation errors. |
||||||
| name |
The playlist name. |
||||||
| songCount read-only |
The number of songs appearing in the playlist. |
||||||
| songs |
The songs in the playlist, represented by their ID. The Ultimate music plan supports addition of up to 20 songs in a playlist. The limited music plans support addition of 3 songs in a playlist. Submitting more songs than the subscribed plan supports will result in a 400 with validation errors.
|
||||||
| type |
The type of object represented. |
API errors come in two kinds of varieties: 400s and 500s.
Any error with a status code of 400 to 499 is considered a client error. This means it’s usually an error you can handle in your app, and then resend a modified request to the ShootProof API to get a successful response.
An error in the range of 500 to 599, on the other hand, is a different story. These errors usually mean that a problem occured on the server and resending the request with modifications will not fix the issue.
Pay careful attention to the status codes. We try to stick as close as possible to their defined semantics. For a complete list of HTTP status codes, take a look at the official HTTP Status Code Registry.
Check out our errors guide for more information.
When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| detail |
A longer description of of the error encountered. |
||||||||||||
| info |
Additional information that may be provided to aid in error resolution.
|
||||||||||||
| status |
The HTTP status code associated with this error. |
||||||||||||
| title |
A short description of the error encountered. |
||||||||||||
| type |
A namespace URI uniquely identifying the error type. |
{
"detail": "There was a problem with your request. Please see `info` for more information.",
"info": {
"errors": {
"type": {
"isEmpty": "Value is required and can't be empty"
}
}
},
"status": 400,
"title": "Bad Request",
"type": "https://developer.shootproof.com/errors#error-bad-request"
}{
"detail": "You do not have permission to access the requested resource.",
"status": 403,
"title": "Forbidden",
"type": "https://developer.shootproof.com/errors#error-forbidden"
}{
"detail": "The requested resource could not be found.",
"status": 404,
"title": "Not Found",
"type": "https://developer.shootproof.com/errors#error-not-found"
}{
"detail": "An error occurred on the server. If this error continues to occur, please contact support.",
"status": 500,
"title": "Internal Server Error",
"type": "https://developer.shootproof.com/errors#error-server-error"
}{
"detail": "No authorization credentials provided. You must provide an authorization token for this request.",
"status": 401,
"title": "Unauthorized",
"type": "https://developer.shootproof.com/errors#error-unauthorized"
}The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"200": {
"content": {
"application/vnd.shootproof+json": {
"schema": {
"$ref": "#/components/schemas/Playlist"
}
}
},
"description": "A Playlist"
},
"default": {
"$ref": "#/components/responses/defaultError"
}
}Updates a Playlist for the studio. Playlists are shared across all brands in the studio.
All songs on the Playlist will be overwritten with values in the songs property of the request.
The songs will be ordered in the playlist according to their order in the songs request property.
/studio/playlist/{playlistId}We’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| playlistId required |
The playlist identifier. |
| Property | Description |
|---|---|
| Authentication required |
The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens. |
The playlist.
| Property | Description | ||||||
|---|---|---|---|---|---|---|---|
| name |
The playlist name. |
||||||
| songs |
The songs in the playlist, represented by their ID. The Ultimate music plan supports addition of up to 20 songs in a playlist. The limited music plans support addition of 3 songs in a playlist. Submitting more songs than the subscribed plan supports will result in a 400 with validation errors.
|
||||||
| type |
The type of object represented. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"content": {
"application/vnd.shootproof+json": {
"schema": {
"$ref": "#/components/schemas/Playlist"
}
}
},
"description": "The playlist.",
"required": true
}200 OKMusic playlist response.
When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.
| Property | Description | ||||||
|---|---|---|---|---|---|---|---|
| created read-only |
The creation date of this playlist. |
||||||
| id read-only |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||
| isEditable read-only |
Flag indicating whether the playlist is editable by the studio. Playlists created by the studio have a true value here, playlists created by the system (ie: featured playlists) are false. If this value is true, the playlist can be neither edited or deleted by the studio via the API. If this value is false, submitting an update to this playlist will result in a 400 with validation errors. |
||||||
| name |
The playlist name. |
||||||
| songCount read-only |
The number of songs appearing in the playlist. |
||||||
| songs |
The songs in the playlist, represented by their ID. The Ultimate music plan supports addition of up to 20 songs in a playlist. The limited music plans support addition of 3 songs in a playlist. Submitting more songs than the subscribed plan supports will result in a 400 with validation errors.
|
||||||
| type |
The type of object represented. |
400 Bad RequestValidation error response. Check the info.errors property in the response for more details.
When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| detail |
A longer description of of the error encountered. |
||||||||||||||
| info |
Additional information that may be provided to aid in error resolution.
|
||||||||||||||
| status |
The HTTP status code associated with this error. |
||||||||||||||
| title |
A short description of the error encountered. |
||||||||||||||
| type |
A namespace URI uniquely identifying the error type. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"200": {
"content": {
"application/vnd.shootproof+json": {
"schema": {
"$ref": "#/components/schemas/Playlist"
}
}
},
"description": "Music playlist response."
},
"400": {
"$ref": "#/components/responses/validationError"
}
}Beware, URLs can exceed the 2048 character limit imposed by some browsers. A POST version of this endpoint is provided for such cases.
Across categories, filters are added. So, if a style and a theme are selected, matching songs must match the theme and the style. Within categories, filters are applied with an OR operator. So, if multiple styles and themes are selected, matching songs must match at least one of the styles and at least one of the themes.
/studio/songWe’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| filterArtist |
Filter items returned by artist. Available values can be found at |
| filterDurationMax |
Filter items having a maximum duration of _. |
| filterDurationMin |
Filter items having a minimum duration of _. |
| filterInstrument |
Filter items returned by instrument. Available values can be found at |
| filterIsInstrumental |
Filter items matching isInstrumental. |
| filterMood |
Filter items returned by mood. Available values can be found at |
| filterPlan |
Filter items returned by Music Plan. Available values can be found at |
| filterStyle |
Filter items returned by style. Available values can be found at |
| filterTempo |
Filter items matching tempo. |
| filterTheme |
Filter items returned by theme. Available values can be found at |
| page |
The page of results to return. |
| rows |
The number of rows to return on each page of results. |
| searchArtist |
String partially matching search of artist names. |
| searchLyrics |
String matching a complete word/phrase found in the song's lyrics field. If |
| searchTitle |
String matching a complete word/phrase found in the song's title field. |
| Property | Description |
|---|---|
| Authentication required |
The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens. |
200 OKA collection of songs
When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| items |
A collection of resources returned in the current result set.
|
||||||||||||||||||||||||||||||||||||
| links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name. |
||||||||||||||||||||||||||||||||||||
| meta read-only |
Metadata describing the current result set.
|
||||||||||||||||||||||||||||||||||||
| type |
The type of resource represented. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"200": {
"content": {
"application/vnd.shootproof+json": {
"schema": {
"$ref": "#/components/schemas/SongCollection"
}
}
},
"description": "A collection of songs"
}
}This is a POST request because the combined values of filter parameters can exceed the max supported URL length of 2048 characters.
Across categories, filters are added. So, if a style and a theme are selected, matching songs must match the theme and the style. Within categories, filters are applied with an OR operator. So, if multiple styles and themes are selected, matching songs must match at least one of the styles and at least one of the themes.
/studio/songWe’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| page |
The page of results to return. |
| rows |
The number of rows to return on each page of results. |
| sortType |
The direction in which sorting should occur. |
| Property | Description |
|---|---|
| Authentication required |
The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens. |
A song search request
| Property | Description |
|---|---|
| filterArtist nullable |
Filter items returned by artist. Available values can be found at |
| filterDurationMax nullable |
Filter items having a maximum duration of _. |
| filterDurationMin nullable |
Filter items having a minimum duration of _. |
| filterInstrument nullable |
Filter items returned by instrument. Available values can be found at |
| filterIsInstrumental |
Filter items matching isInstrumental. |
| filterMood nullable |
Filter items returned by mood. Available values can be found at |
| filterPlan nullable |
Filter items returned by Music Plan. Available values can be found at |
| filterStyle nullable |
Filter items returned by style. Available values can be found at |
| filterTempo nullable |
Filter items matching tempo. |
| filterTheme nullable |
Filter items returned by theme. Available values can be found at |
| searchArtist nullable |
String partially matching search of artist names. |
| searchLyrics nullable |
String matching a complete word/phrase found in the song's lyrics field. If |
| searchTitle nullable |
String matching a complete word/phrase found in the song's title field. |
| type |
The type of object represented |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"content": {
"application/vnd.shootproof+json": {
"schema": {
"description": "The song search parameters.",
"properties": {
"filterArtist": {
"description": "Filter items returned by artist. Available values can be found at `/song/artist`. If\nmore than one value is present, matching songs will have at least one of the given\nvalues.",
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"filterDurationMax": {
"description": "Filter items having a maximum duration of _.",
"nullable": true,
"type": "integer"
},
"filterDurationMin": {
"description": "Filter items having a minimum duration of _.",
"nullable": true,
"type": "integer"
},
"filterInstrument": {
"description": "Filter items returned by instrument. Available values can be found at `/song/instrument`.\nIf more than one value is present, matching songs will have at least one of the given values.",
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"filterIsInstrumental": {
"description": "Filter items matching isInstrumental.",
"type": "boolean"
},
"filterMood": {
"description": "Filter items returned by mood. Available values can be found at `/song/mood`. If\nmore than one value is present, matching songs will have at least one of the given\nvalues.",
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"filterPlan": {
"description": "Filter items returned by Music Plan. Available values can be found at `/song/plan`.",
"nullable": true,
"type": "string"
},
"filterStyle": {
"description": "Filter items returned by style. Available values can be found at `/song/style`. If\nmore than one value is present, matching songs will have at least one of the given\nvalues.",
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"filterTempo": {
"description": "Filter items matching tempo.",
"enum": [
"fast",
"slow",
"medium"
],
"nullable": true,
"type": "string"
},
"filterTheme": {
"description": "Filter items returned by theme. Available values can be found at `/song/theme`. If\nmore than one value is present, matching songs will have at least one of the given\nvalues.",
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"searchArtist": {
"description": "String partially matching search of artist names.",
"nullable": true,
"type": "string"
},
"searchLyrics": {
"description": "String matching a complete word/phrase found in the song's lyrics field.\n\nIf `searchTitle` is present in the request, results will contain songs having either a\nmatching `searchTitle` or `searchLyrics`",
"nullable": true,
"type": "string"
},
"searchTitle": {
"description": "String matching a complete word/phrase found in the song's title field.",
"nullable": true,
"type": "string"
},
"type": {
"description": "The type of object represented",
"enum": [
"song-collection"
],
"type": "string"
}
},
"title": "Song search",
"type": "object"
}
}
},
"description": "A song search request",
"required": true
}200 OKA collection of songs
When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| items |
A collection of resources returned in the current result set.
|
||||||||||||||||||||||||||||||||||||
| links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name. |
||||||||||||||||||||||||||||||||||||
| meta read-only |
Metadata describing the current result set.
|
||||||||||||||||||||||||||||||||||||
| type |
The type of resource represented. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"200": {
"content": {
"application/vnd.shootproof+json": {
"schema": {
"$ref": "#/components/schemas/SongCollection"
}
}
},
"description": "A collection of songs"
}
}/studio/song/artistWe’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| Authentication required |
The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens. |
200 OKA collection of song artists.
When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| items |
A collection of resources returned in the current result set.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| meta read-only |
Metadata describing the current result set.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type |
The type of resource represented. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"200": {
"content": {
"application/vnd.shootproof+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/List"
},
{
"description": "A collection of song artists.",
"properties": {
"items": {
"items": {
"description": "A song artist",
"properties": {
"type": {
"enum": [
"song-artist"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"title": "Song artist",
"type": "array"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"type": {
"enum": [
"song-artist-collection"
],
"type": "string"
}
},
"title": "Collection of song artists",
"type": "object"
}
]
}
}
},
"description": "A collection of song artists."
}
}/studio/song/instrumentWe’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| Authentication required |
The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens. |
200 OKA collection of song instruments.
When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| items |
A collection of resources returned in the current result set.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| meta read-only |
Metadata describing the current result set.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type |
The type of resource represented. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"200": {
"content": {
"application/vnd.shootproof+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/List"
},
{
"description": "A collection of song instruments.",
"properties": {
"items": {
"items": {
"description": "A song instrument",
"properties": {
"type": {
"enum": [
"song-instrument"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"title": "Song instrument",
"type": "array"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"type": {
"enum": [
"song-instrument-collection"
],
"type": "string"
}
},
"title": "Collection of song instruments",
"type": "object"
}
]
}
}
},
"description": "A collection of song instruments."
}
}/studio/song/moodWe’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| Authentication required |
The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens. |
200 OKA collection of song moods.
When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| items |
A collection of resources returned in the current result set.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| meta read-only |
Metadata describing the current result set.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type |
The type of resource represented. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"200": {
"content": {
"application/vnd.shootproof+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/List"
},
{
"description": "A collection of song moods.",
"properties": {
"items": {
"items": {
"description": "A song mood",
"properties": {
"type": {
"enum": [
"song-mood"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"title": "Song mood",
"type": "array"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"type": {
"enum": [
"song-mood-collection"
],
"type": "string"
}
},
"title": "Collection of song moods",
"type": "object"
}
]
}
}
},
"description": "A collection of song moods."
}
}/studio/song/planWe’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| Authentication required |
The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens. |
200 OKA collection of song Music Plans.
When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| items |
A collection of resources returned in the current result set.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| meta read-only |
Metadata describing the current result set.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type |
The type of resource represented. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"200": {
"content": {
"application/vnd.shootproof+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/List"
},
{
"description": "A collection of song Music Plans.",
"properties": {
"items": {
"items": {
"description": "A song Music Plan",
"properties": {
"type": {
"enum": [
"song-plan"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"title": "Song Music Plan",
"type": "array"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"type": {
"enum": [
"song-plan-collection"
],
"type": "string"
}
},
"title": "Collection of song Music Plans",
"type": "object"
}
]
}
}
},
"description": "A collection of song Music Plans."
}
}/studio/song/styleWe’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| Authentication required |
The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens. |
200 OKA collection of song styles.
When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| items |
A collection of resources returned in the current result set.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| meta read-only |
Metadata describing the current result set.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type |
The type of resource represented. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"200": {
"content": {
"application/vnd.shootproof+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/List"
},
{
"description": "A collection of song styles.",
"properties": {
"items": {
"items": {
"description": "A song style",
"properties": {
"type": {
"enum": [
"song-style"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"title": "Song style",
"type": "array"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"type": {
"enum": [
"song-style-collection"
],
"type": "string"
}
},
"title": "Collection of song styles",
"type": "object"
}
]
}
}
},
"description": "A collection of song styles."
}
}/studio/song/themeWe’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| Authentication required |
The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens. |
200 OKA collection of song themes.
When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| items |
A collection of resources returned in the current result set.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| meta read-only |
Metadata describing the current result set.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type |
The type of resource represented. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"200": {
"content": {
"application/vnd.shootproof+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/List"
},
{
"description": "A collection of song themes.",
"properties": {
"items": {
"items": {
"description": "A song theme",
"properties": {
"type": {
"enum": [
"song-theme"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"title": "Song theme",
"type": "array"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"type": {
"enum": [
"song-theme-collection"
],
"type": "string"
}
},
"title": "Collection of song themes",
"type": "object"
}
]
}
}
},
"description": "A collection of song themes."
}
}