Skip to main content
POST
/
search
Search IP Assets
curl --request POST \
  --url https://api.storyapis.com/api/v4/search \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "query": "<string>",
  "pagination": {
    "limit": 20,
    "offset": 0
  }
}
'
{
  "data": [
    {
      "description": "<string>",
      "ipId": "<string>",
      "mediaType": "<string>",
      "score": 123,
      "similarity": 123,
      "title": "<string>"
    }
  ],
  "total": 123,
  "$schema": "<string>",
  "pagination": {
    "hasMore": true,
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.story.foundation/llms.txt

Use this file to discover all available pages before exploring further.

Search is done by vectorizing the title and description of the IP metadata using the IPA metadata standard.

Authorizations

X-Api-Key
string
header
required

Body

application/json
query
string
required

The search query string

Required string length: 1 - 1000
Example:

"dragon NFT"

mediaType
enum<string>

Optional media type filter - must be 'audio', 'video', or 'image'. Leave empty to search all media types

Available options:
audio,
video,
image
Example:

"image"

pagination
object

Pagination configuration

Response

OK

data
object[] | null
required

List of IP asset search results

total
integer<int64>
required

Total number of search results found

$schema
string<uri>
read-only

A URL to the JSON Schema for this object.

Example:

"https://api.storyapis.com/api/v4/SearchResponseBodyHuma.json"

pagination
object

Pagination information