Search captioned images

curl --request POST \
  --url https://api.lightdrift.ai/v1/search \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "query": "<string>"
}
'

import requests

url = "https://api.lightdrift.ai/v1/search"

payload = { "query": "<string>" }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({query: '<string>'})
};

fetch('https://api.lightdrift.ai/v1/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "query_id": "q_33b7214c7da1a07ce4355a40",
  "results": [
    {
      "asset_id": "isorepublic:17191",
      "score": 0.921875,
      "title": "Mini in Brooklyn",
      "source": "isorepublic",
      "ai_generated": false,
      "width": 4000,
      "height": 2667,
      "file": "https://api.lightdrift.ai/v1/asset/q_33b7214c7da1a07ce4355a40/isorepublic:17191",
      "thumb": "https://api.lightdrift.ai/v1/asset/q_33b7214c7da1a07ce4355a40/isorepublic:17191?v=thumb",
      "rights": {
        "license": "cc0",
        "license_verbatim": "CC0 1.0",
        "commercial": true,
        "attribution_required": false,
        "derivatives": true,
        "share_alike": false,
        "attribution": null,
        "provenance_url": "https://isorepublic.com/photo/mini-in-brooklyn/",
        "basis": "as-declared by source; verify for critical use"
      }
    },
    {
      "asset_id": "flickr:51141533761",
      "score": 0.90234375,
      "title": "Night in the city-2",
      "source": "flickr",
      "ai_generated": false,
      "width": 1023,
      "height": 968,
      "file": "https://api.lightdrift.ai/v1/asset/q_33b7214c7da1a07ce4355a40/flickr:51141533761",
      "thumb": "https://api.lightdrift.ai/v1/asset/q_33b7214c7da1a07ce4355a40/flickr:51141533761?v=thumb",
      "rights": {
        "license": "cc-by-sa",
        "license_verbatim": "CC BY-SA 2.0",
        "commercial": true,
        "attribution_required": true,
        "derivatives": true,
        "share_alike": true,
        "attribution": "\"Night in the city-2\" by Tatiana El-Bakri, flickr, CC BY-SA",
        "provenance_url": "https://www.flickr.com/photos/189281045@N03/51141533761",
        "basis": "as-declared by source; verify for critical use"
      }
    },
    {
      "asset_id": "yfcc:9715466326",
      "score": 0.85546875,
      "title": "MINIPalooza 2013",
      "source": "yfcc",
      "ai_generated": false,
      "width": 1024,
      "height": 575,
      "file": "https://api.lightdrift.ai/v1/asset/q_33b7214c7da1a07ce4355a40/yfcc:9715466326",
      "thumb": "https://api.lightdrift.ai/v1/asset/q_33b7214c7da1a07ce4355a40/yfcc:9715466326?v=thumb",
      "rights": {
        "license": "cc-by",
        "license_verbatim": "by <>",
        "commercial": true,
        "attribution_required": true,
        "derivatives": true,
        "share_alike": false,
        "attribution": "\"MINIPalooza 2013\" by unknown, yfcc, CC BY 4.0/3.0/2.0",
        "provenance_url": "http://www.flickr.com/photos/101530550@N05/9715466326/",
        "basis": "as-declared by source; verify for critical use"
      }
    },
    {
      "asset_id": "yfcc:9958535786",
      "score": 0.85546875,
      "title": "Study in Blue - Phibsboro [Dublin] - 89 Phibsborough Road",
      "source": "yfcc",
      "ai_generated": false,
      "width": 1023,
      "height": 697,
      "file": "https://api.lightdrift.ai/v1/asset/q_33b7214c7da1a07ce4355a40/yfcc:9958535786",
      "thumb": "https://api.lightdrift.ai/v1/asset/q_33b7214c7da1a07ce4355a40/yfcc:9958535786?v=thumb",
      "rights": {
        "license": "cc-by-sa",
        "license_verbatim": "by-sa <>",
        "commercial": true,
        "attribution_required": true,
        "derivatives": true,
        "share_alike": true,
        "attribution": "\"Study in Blue - Phibsboro [Dublin] - 89 Phibsborough Road\" by unknown, yfcc, CC BY-SA",
        "provenance_url": "http://www.flickr.com/photos/80824546@N00/9958535786/",
        "basis": "as-declared by source; verify for critical use"
      }
    },
    {
      "asset_id": "wm_quality:194126027",
      "score": 0.8359375,
      "title": "AC BD Lochnerstraße 21.jpg",
      "source": "wm_quality",
      "ai_generated": false,
      "width": 2581,
      "height": 3226,
      "file": "https://api.lightdrift.ai/v1/asset/q_33b7214c7da1a07ce4355a40/wm_quality:194126027",
      "thumb": "https://api.lightdrift.ai/v1/asset/q_33b7214c7da1a07ce4355a40/wm_quality:194126027?v=thumb",
      "rights": {
        "license": "cc-by-sa",
        "license_verbatim": "CC BY-SA 4.0",
        "commercial": true,
        "attribution_required": true,
        "derivatives": true,
        "share_alike": true,
        "attribution": "\"AC BD Lochnerstraße 21.jpg\" by Grunpfnul, wm_quality, CC BY-SA",
        "provenance_url": "https://commons.wikimedia.org/wiki/File:AC_BD_Lochnerstra%C3%9Fe_21.jpg",
        "basis": "as-declared by source; verify for critical use"
      }
    }
  ],
  "latency_ms": 439,
  "timing_ms": {
    "embed": 180,
    "retrieve": 70,
    "rerank": 161
  },
  "mode": "text",
  "ranking": "text",
  "pool_size": 131,
  "reranked": 60,
  "backend": "voyage"
}

POST

Search captioned images

curl --request POST \
  --url https://api.lightdrift.ai/v1/search \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "query": "<string>"
}
'

import requests

url = "https://api.lightdrift.ai/v1/search"

payload = { "query": "<string>" }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({query: '<string>'})
};

fetch('https://api.lightdrift.ai/v1/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "query_id": "q_33b7214c7da1a07ce4355a40",
  "results": [
    {
      "asset_id": "isorepublic:17191",
      "score": 0.921875,
      "title": "Mini in Brooklyn",
      "source": "isorepublic",
      "ai_generated": false,
      "width": 4000,
      "height": 2667,
      "file": "https://api.lightdrift.ai/v1/asset/q_33b7214c7da1a07ce4355a40/isorepublic:17191",
      "thumb": "https://api.lightdrift.ai/v1/asset/q_33b7214c7da1a07ce4355a40/isorepublic:17191?v=thumb",
      "rights": {
        "license": "cc0",
        "license_verbatim": "CC0 1.0",
        "commercial": true,
        "attribution_required": false,
        "derivatives": true,
        "share_alike": false,
        "attribution": null,
        "provenance_url": "https://isorepublic.com/photo/mini-in-brooklyn/",
        "basis": "as-declared by source; verify for critical use"
      }
    },
    {
      "asset_id": "flickr:51141533761",
      "score": 0.90234375,
      "title": "Night in the city-2",
      "source": "flickr",
      "ai_generated": false,
      "width": 1023,
      "height": 968,
      "file": "https://api.lightdrift.ai/v1/asset/q_33b7214c7da1a07ce4355a40/flickr:51141533761",
      "thumb": "https://api.lightdrift.ai/v1/asset/q_33b7214c7da1a07ce4355a40/flickr:51141533761?v=thumb",
      "rights": {
        "license": "cc-by-sa",
        "license_verbatim": "CC BY-SA 2.0",
        "commercial": true,
        "attribution_required": true,
        "derivatives": true,
        "share_alike": true,
        "attribution": "\"Night in the city-2\" by Tatiana El-Bakri, flickr, CC BY-SA",
        "provenance_url": "https://www.flickr.com/photos/189281045@N03/51141533761",
        "basis": "as-declared by source; verify for critical use"
      }
    },
    {
      "asset_id": "yfcc:9715466326",
      "score": 0.85546875,
      "title": "MINIPalooza 2013",
      "source": "yfcc",
      "ai_generated": false,
      "width": 1024,
      "height": 575,
      "file": "https://api.lightdrift.ai/v1/asset/q_33b7214c7da1a07ce4355a40/yfcc:9715466326",
      "thumb": "https://api.lightdrift.ai/v1/asset/q_33b7214c7da1a07ce4355a40/yfcc:9715466326?v=thumb",
      "rights": {
        "license": "cc-by",
        "license_verbatim": "by <>",
        "commercial": true,
        "attribution_required": true,
        "derivatives": true,
        "share_alike": false,
        "attribution": "\"MINIPalooza 2013\" by unknown, yfcc, CC BY 4.0/3.0/2.0",
        "provenance_url": "http://www.flickr.com/photos/101530550@N05/9715466326/",
        "basis": "as-declared by source; verify for critical use"
      }
    },
    {
      "asset_id": "yfcc:9958535786",
      "score": 0.85546875,
      "title": "Study in Blue - Phibsboro [Dublin] - 89 Phibsborough Road",
      "source": "yfcc",
      "ai_generated": false,
      "width": 1023,
      "height": 697,
      "file": "https://api.lightdrift.ai/v1/asset/q_33b7214c7da1a07ce4355a40/yfcc:9958535786",
      "thumb": "https://api.lightdrift.ai/v1/asset/q_33b7214c7da1a07ce4355a40/yfcc:9958535786?v=thumb",
      "rights": {
        "license": "cc-by-sa",
        "license_verbatim": "by-sa <>",
        "commercial": true,
        "attribution_required": true,
        "derivatives": true,
        "share_alike": true,
        "attribution": "\"Study in Blue - Phibsboro [Dublin] - 89 Phibsborough Road\" by unknown, yfcc, CC BY-SA",
        "provenance_url": "http://www.flickr.com/photos/80824546@N00/9958535786/",
        "basis": "as-declared by source; verify for critical use"
      }
    },
    {
      "asset_id": "wm_quality:194126027",
      "score": 0.8359375,
      "title": "AC BD Lochnerstraße 21.jpg",
      "source": "wm_quality",
      "ai_generated": false,
      "width": 2581,
      "height": 3226,
      "file": "https://api.lightdrift.ai/v1/asset/q_33b7214c7da1a07ce4355a40/wm_quality:194126027",
      "thumb": "https://api.lightdrift.ai/v1/asset/q_33b7214c7da1a07ce4355a40/wm_quality:194126027?v=thumb",
      "rights": {
        "license": "cc-by-sa",
        "license_verbatim": "CC BY-SA 4.0",
        "commercial": true,
        "attribution_required": true,
        "derivatives": true,
        "share_alike": true,
        "attribution": "\"AC BD Lochnerstraße 21.jpg\" by Grunpfnul, wm_quality, CC BY-SA",
        "provenance_url": "https://commons.wikimedia.org/wiki/File:AC_BD_Lochnerstra%C3%9Fe_21.jpg",
        "basis": "as-declared by source; verify for critical use"
      }
    }
  ],
  "latency_ms": 439,
  "timing_ms": {
    "embed": 180,
    "retrieve": 70,
    "rerank": 161
  },
  "mode": "text",
  "ranking": "text",
  "pool_size": 131,
  "reranked": 60,
  "backend": "voyage"
}

Authorizations

X-API-Key

string

header

required

Your Lightdrift API key. Usage is metered per query.

Headers

Idempotency-Key

string

default:""

Body

application/json

query

string

required

integer

default:10

Required range: 1 <= x <= 100

ann_k

integer

default:100

Required range: 1 <= x <= 1000

bm25_k

integer

default:50

Required range: 0 <= x <= 1000

ann_ef

integer

default:2048

Required range: 64 <= x <= 4096

mode

enum<string>

default:auto

Available options:

auto,

none,

text

rerank

boolean | null

rerank_k

integer | null

default:60

Required range: 1 <= x <= 500

rerank_text

boolean

default:true

explain

boolean

default:false

filters

Filters · object

Show child attributes

include_graphics

boolean | null

client_session

string | null

experiment

string | null

Response

Search results and source-declared rights.

query_id

string

results

object[]

Show child attributes

latency_ms

integer

timing_ms

object

Show child attributes

mode

string

ranking

string

Actual ordering, including text, visual, none, or none (degraded).

pool_size

integer

reranked

integer

backend

string

Voyage responses report voyage; legacy responses may omit this field.

degraded

string

Reranker unavailable; results are in retrieval order. Successful billed response.

relaxed

string[]

Default filters relaxed to fill results; explicit constraints are not relaxed.

Getting started

Endpoints

Search captioned images

Authorizations

Headers

Body

Response