Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/api-spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ Beatoven.ai API uses an API token based authentication. With each request, you n
- [Checking composition status](https://github.com/Beatoven/public-api/blob/main/docs/api-spec.md#checking-composition-status)
- [Fetching a track](https://github.com/Beatoven/public-api/blob/main/docs/api-spec.md#get-composed-track)
- [Fetching supported options](https://github.com/Beatoven/public-api/blob/main/docs/api-spec.md#supported-options)
- [API Usage](https://github.com/Beatoven/public-api/blob/main/docs/api-spec.md#api-usage)


## Creating a new track

Expand Down Expand Up @@ -373,3 +375,25 @@ You can use this API, to get the supported values for track parameters like genr
Fields like `genre`, `mood` and `tempo` might be self-explainatory.

`blockedParameters`: While most of the options in genre, mood and tempo can be combined to create a track. Some combinations might lead to errors due to limitations in our composition system. The list in the value of `blockedParameters` is a list of those combinations.


## API Usage

Get usage info of your API token


**Endpoint**

`GET /api/v1/usage`

**Payload Example**

```json
{
"email": "test@email.com",
"usage": {
"calls_made": 10,
"remaining_calls": 1729,
},
}
```