Welcome to the Audiosocket API! Our API allows you to interact with Audiosocket's platform to access and manage audio content efficiently. This documentation will guide you through the various endpoints available, how to authenticate your requests, and examples of how to use the API.
\nThe Audiosocket API uses Bearer Token authentication to ensure secure access to our services. You will need to include the Bearer Token in the Authorization header of your requests. Here’s how you can do it:
\nObtain a Bearer Token:
\nInclude the Bearer Token in Requests:
\nThe token will be given by Audiosocket which you can replace with ffm9neqksfugx33b2th4czb9z variable in postman to run the calls.
\nThe Audiosocket API uses standard HTTP status codes to indicate the success or failure of an API request. Here’s a guide to the most common status codes you may encounter while using the API:
\n2xx: Success
\n{ \"status\": 200, \"message\": \"OK\", \"data\": [ /* array of tracks */ ]}
\nGET request to retrieve a list of tracks succeeded.{ \"status\": 201, \"message\": \"Created\", \"data\": { /* newly created track data */ }}
\nPOST request to create a new track succeeded.{ \"status\": 204, \"message\": \"No Content\"}
\nDELETE request to remove a track succeeded.{ \"status\": 400, \"message\": \"Bad Request\", \"error\": \"Invalid or missing parameters\"}
\n{ \"status\": 401, \"message\": \"Unauthorized\", \"error\": \"Invalid or missing Bearer Token\"}
\n{ \"status\": 403, \"message\": \"Forbidden\", \"error\": \"Access to this resource is denied\"}
\n{ \"status\": 404, \"message\": \"Not Found\", \"error\": \"Resource not found\"}
\nGET request for a track with a non-existent ID.{ \"status\": 409, \"message\": \"Conflict\", \"error\": \"Resource conflict\"}
\n{ \"status\": 500, \"message\": \"Internal Server Error\", \"error\": \"An unexpected error occurred\"}
\n{ \"status\": 503, \"message\": \"Service Unavailable\", \"error\": \"The server is currently unavailable\"}
\nQuery Object Documentation:
\nThe query parameter is a JSON object that can be stringified using JSON.stringify(). This object allows you to filter the results based on various criteria. Below is the structure of the query object used in the example:
genres (array of strings): Filter tracks by genres. The genres should be specified as an array of strings.Example query object:
{\n \"genres\": [\"blues\", \"cajun\"]\n}\n\nTo use this in Postman, you need to stringify the JSON object:
\nStringified query object:
{\"genres\":[\"blues\",\"cajun\"]}\n\nSort Object Documentation:
\nThe sort parameter is also a JSON object that can be stringified. This object allows you to specify the sorting order for the results. Below is the structure of the sort object used in the example:
featured (integer): Sort by the featured status. Use -1 for descending order.
createdAt (integer): Sort by the creation date. Use -1 for descending order.
Example sort object:
{\n \"featured\": -1,\n \"createdAt\": -1\n}\n\nTo use this in Postman, you need to stringify the JSON object:
\nStringified sort object:
{\"featured\":-1,\"createdAt\":-1}\n\nQuery Object Documentation:
\nThe query parameter is a JSON object that can be stringified using JSON.stringify(). This object allows you to filter the results based on various criteria. Below is the structure of the query object used in the example:
moods (array of strings): Filter tracks by moods. The moods should be specified as an array of strings.Example query object:
{\n \"moods\": [\"angry\", \"dark\"]\n}\n\nTo use this in Postman, you need to stringify the JSON object:
\nStringified query object:
{\"moods\":[\"angry\",\"dark\"]}\n\nQuery Object Documentation:
\nThe query parameter is a JSON object that can be stringified using JSON.stringify(). This object allows you to filter the results based on various criteria. Below is the structure of the query object used in the example:
themes (array of strings): Filter tracks by themes. The themes should be specified as an array of strings.Example query object:
{\n \"themes\": [\"children music\"]\n}\n\nTo use this in Postman, you need to stringify the JSON object:
\nStringified query object:
{\"themes\":[\"children music\"],\"collections\":[\"audiosocket\"]}\n\nQuery Object Documentation:
\nThe query parameter is a JSON object that can be stringified using JSON.stringify(). This object allows you to filter the results based on various criteria. Below is the structure of the query object used in the example:
duration (array of arrays): Filter tracks by duration range. Each inner array specifies a range of durations [min, max].Example query object:
{\n \"duration\": [[258, 374]]\n}\n\nTo use this in Postman, you need to stringify the JSON object:
\nStringified query object:
{\"duration\":[[258,374]]}\n\nQuery Object Documentation:
\nThe query parameter is a JSON object that can be stringified using JSON.stringify(). This object allows you to filter the results based on various criteria. Below is the structure of the query object used in the example:
tempo (array of strings): Filter tracks by tempo range. Each string specifies a tempo range in BPM.Example query object:
{\n \"tempo\": [\"60-80\"]\n}\n\nTo use this in Postman, you need to stringify the JSON object:
\nStringified query object:
{\"tempo\":[\"60-80\"]}\n\nQuery Object Documentation:
\nThe query parameter is a JSON object that can be stringified using JSON.stringify(). This object allows you to filter the results based on various criteria. Below is the structure of the query object used in the example:
instruments (array of strings): Filter tracks by instruments. The instruments should be specified as an array of strings.Example query object:
{\n \"instruments\": [\"mirlitons\", \"vintage\"]\n}\n\nTo use this in Postman, you need to stringify the JSON object:
\nStringified query object:
{\"instruments\":[\"mirlitons\",\"vintage\"]}\n\nQuery Object Documentation:
\nThe query parameter is a JSON object that can be stringified using JSON.stringify(). This object allows you to filter the results based on various criteria. Below is the structure of the query object used in the example:
switches (array of strings): Filter tracks by switches. The switches should be specified as an array of strings.Example query object:
{\n \"switches\": [\"explicit\"]\n}\n\nTo use this in Postman, you need to stringify the JSON object:
\nStringified query object:
{\"switches\":[\"explicit\"]}\n\nQuery Object Documentation:
\nThe query parameter is a JSON object that can be stringified using JSON.stringify(). This object allows you to filter the results based on various criteria. Below is the structure of the query object used in the example:
switches (array of strings): Filter tracks by switches. The switches should be specified as an array of strings.Example query object:
{\n \"switches\": [\"youTubeCidCleared\"]\n}\n\nTo use this in Postman, you need to stringify the JSON object:
\nStringified query object:
{\"switches\":[\"youTubeCidCleared\"]}\n\nQuery Object Documentation:
\nThe query parameter is a JSON object that can be stringified using JSON.stringify(). This object allows you to filter the results based on various criteria. Below is the structure of the query object used in the example:
switches (array of strings): Filter tracks by switches. The switches should be specified as an array of strings.Example query object:
{\n \"switches\": [\"instrumental\"]\n}\n\nTo use this in Postman, you need to stringify the JSON object:
\nStringified query object:
{\"switches\":[\"instrumental\"]}\n\nQuery Object Documentation:
\nThe query parameter is a JSON object that can be stringified using JSON.stringify(). This object allows you to filter the results based on various criteria. Below is the structure of the query object used in the example:
similar (array of strings): Filter tracks similar to a specific track ID. The IDs should be specified as an array of strings with the format id:track_id.Example query object:
{\n \"similar\": [\"id:120582764\"]\n}\n\nTo use this in Postman, you need to stringify the JSON object:
\nStringified query object:
{\"similar\":[\"id:120582764\"]}\n\nQuery Object Documentation:
\nThe query parameter is a JSON object that can be stringified using JSON.stringify(). This object allows you to filter the results based on various criteria. Below is the structure of the query object used in the example:
similar (array of strings): Filter tracks similar to a specific YouTube URL. The URL should be specified as a string in the format url:youtube_url.Example query object:
{\n \"similar\": [\"url:https://www.youtube.com/watch?v=mRD0-GxqHVo\"]\n}\n\nTo use this in Postman, you need to stringify the JSON object:
\nStringified query object:
{\"similar\":[\"url:https://www.youtube.com/watch?v=mRD0-GxqHVo\"]}\n\nQuery Object Documentation:
\nThe query parameter is a JSON object that can be stringified using JSON.stringify(). This object allows you to filter the results based on various criteria. Below is the structure of the query object used in the example:
free (array of strings): Filter tracks that are free. The value should be an array with the string \"zero\" to indicate tracks that cost zero.Example query object:
{\n \"free\": [\"zero\"]\n}\n\nTo use this in Postman, you need to stringify the JSON object:
\nStringified query object:
{\"free\":[\"zero\"]}\n\nQuery Parameters:
\npage: The page number of the results (integer).
limit: The number of results per page (integer).
query: A JSON string that specifies filters.
sort: A JSON string that specifies the sorting order.
Query Object Documentation:
\nThe query parameter is a JSON object that allows you to specify filters for different attributes such as genres, moods, themes, instruments, and tempo. These values are fetched dynamically from a mappings API.
genres (array of strings): Filter tracks by genres.
moods (array of strings): Filter tracks by moods.
themes (array of strings): Filter tracks by themes.
instruments (array of strings): Filter tracks by instruments.
tempo (array of strings): Filter tracks by tempo ranges.
Example query object:
{\n \"genres\": [\"rock\", \"pop\"],\n \"moods\": [\"happy\"],\n \"themes\": [\"uplifting\"],\n \"instruments\": [\"guitar\"],\n \"tempo\": [\"60-80\"]\n}\n\nQuery Object Documentation:
\nThe query parameter is typically a simple string parameter used to specify a search term or filter criteria. It does not require JSON stringification as it's a straightforward string value.
query (string): The search term or filter criteria for mappings.Example query parameter:
query=zero\n\n