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 '{
  "mediaType": "image",
  "pagination": {
    "limit": 20,
    "offset": 0
  },
  "query": "dragon NFT"
}'
{
  "$schema": "https://api.storyapis.com/api/v4/SearchResponseBodyHuma.json",
  "data": [
    {
      "description": "<string>",
      "ipId": "<string>",
      "mediaType": "<string>",
      "score": 123,
      "similarity": 123,
      "title": "<string>"
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 123,
    "offset": 123,
    "total": 123
  },
  "total": 123
}
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

Response

200
application/json

OK

The response is of type object.