Skip to main content
POST
/
projects
/
{project_id}
/
content
/
assets
/
search
Search assets
curl --request POST \
  --url https://api.beyondwords.io/v1/projects/{project_id}/content/assets/search \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "type": "image",
  "text": "Example text",
  "source": "gettyimages",
  "orientation": [
    "horizontal",
    "vertical"
  ],
  "pagination": {
    "limit": 10
  },
  "order": {
    "by": "best_match"
  }
}
'
[
  {
    "type": "image",
    "source": "gettyimages",
    "title": "Title 1",
    "created": "2022-01-02 23:59:59 UTC",
    "preview_url": "https://example.com/preview.jpg"
  },
  {
    "type": "image",
    "source": "gettyimages",
    "title": "Title 2",
    "created": "2022-01-03 23:59:59 UTC",
    "preview_url": "https://example.com/preview.jpg"
  }
]

Authorizations

X-Api-Key
string
header
required

Path Parameters

project_id
string
required

project_id

Body

application/json
type
enum<string>
required
Available options:
image,
video
source
enum<string>
Available options:
gettyimages
text
string
specific_people
string[]
orientations
enum<string>[]
Available options:
horizontal,
vertical,
square
created
object
pagination
object
order
object

Response

200 - application/json

successful

type
enum<string>
Available options:
image,
video
source
enum<string>
Available options:
gettyimages
title
string
caption
string | null
created
string | null

Time at which the object was created (ISO 8601)

preview_url
string | null
thumbnail_url
string | null
duration
integer | null
download_object
object