Search sound effects

GET 
/v0/sound-effects/search

Use the sound effects search endpoint to allow users to search within the sound effects library.

Request

Query Parameters

offset int32

Index of the entry track in the response

limit int32

Max number of entries returned in the response, default 50 and max 100

term string

Term for search

sort string
Possible values: [best-match, newest, popular, length, title]
Sort for search
Default value: best-match
order string
Possible values: [asc, desc]
Order
Default value: asc

Responses

200

List of sound effect search results

application/json

Schema

Schema

soundEffects

object[]

required

Array [

id stringrequired

title stringrequired

added date-timerequired

length int32required

images

object

default stringnullable

L stringnullable

M stringnullable

S stringnullable

XS stringnullable

]

pagination

object

required

page int32required

limit int32required

offset int32

links

object

required

next stringnullable

prev stringnullable

Example (from schema)

{
  "soundEffects": [
    {
      "id": "string",
      "title": "string",
      "added": "2024-07-29T15:51:28.071Z",
      "length": 0,
      "images": {
        "default": "string",
        "L": "string",
        "M": "string",
        "S": "string",
        "XS": "string"
      }
    }
  ],
  "pagination": {
    "page": 0,
    "limit": 0,
    "offset": 0
  },
  "links": {
    "next": "string",
    "prev": "string"
  }
}

Example

{
  "soundEffects": [
    {
      "id": "eda0ffec-6381-4aa8-a261-8aa22d914728",
      "title": "Applause",
      "added": "2024-10-11T09:01:46.700986371Z",
      "length": 10,
      "images": {
        "default": "https://image.url?w=300&h=300&fit=fill&q=90&fm=jpg",
        "L": "https://image.url?w=1050&h=1050&fit=fill&q=90&fm=jpg",
        "M": "https://image.url?w=600&h=600&fit=fill&q=90&fm=jpg",
        "S": "https://image.url?w=300&h=300&fit=fill&q=90&fm=jpg",
        "XS": "https://image.url?w=128&h=128&fit=fill&q=90&fm=jpg"
      }
    }
  ],
  "pagination": {
    "page": 2,
    "limit": 10,
    "offset": 10
  },
  "links": {
    "next": "/v0/sound-effects/categories?limit=10&offset=20",
    "prev": "/v0/sound-effects/categories?limit=10&offset=0"
  }
}

400

Bad request.

application/json

Schema

Schema

message stringrequired

Human readable message

errors

object[]

Array [

key stringrequired

Error key

messages string[]required

Error messages

]

Example (from schema)

{
  "message": "string",
  "errors": [
    {
      "key": "string",
      "messages": [
        "string"
      ]
    }
  ]
}

Example

{
  "message": "Bad request"
}

401

Unauthorized. Most likely your access token has expired.

application/json

Schema

Schema

message stringrequired

Human readable message

errors

object[]

Array [

key stringrequired

Error key

messages string[]required

Error messages

]

Example (from schema)

{
  "message": "string",
  "errors": [
    {
      "key": "string",
      "messages": [
        "string"
      ]
    }
  ]
}

Example

{
  "message": "Invalid credentials"
}

429

Rate limit exceeded.

application/json

Schema

Schema

message stringrequired

Human readable message

errors

object[]

Array [

key stringrequired

Error key

messages string[]required

Error messages

]

Example (from schema)

{
  "message": "string",
  "errors": [
    {
      "key": "string",
      "messages": [
        "string"
      ]
    }
  ]
}

Example

{
  "message": "Rate limit exceeded"
}

Loading...