Getting started

1
2
3
4
5
6
7
8curl https://deepsearch.app/api/v1/search \
  -H "Authorization: Bearer $DEEPSEARCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "query": "Ada Lovelace",
        "type": "name",
        "format": "json"
      }'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57{
  "object": "search_result",
  "request_id": "req_01HZY8M7YQ2C7W9F4X9J7Z1H3A",
  "metadata": {
    "api_version": "v1",
    "operation": "search",
    "request_id": "req_01HZY8M7YQ2C7W9F4X9J7Z1H3A",
    "generated_at": "2026-06-19T12:00:00.000Z"
  },
  "usage": {
    "metered": true,
    "percentageCharged": 2,
    "remainingPercent": 98,
    "resetAt": "2026-07-01T00:00:00.000Z",
    "source": "included",
    "credits": 1,
    "allowanceSource": "weekly"
  },
  "hits": [
    {
      "id": "ada-lovelace",
      "name": "Ada Lovelace",
      "headline": "Mathematician · London",
      "initials": "AL",
      "confidence": 82,
      "location": "London, United Kingdom",
      "tags": [
        "3 social profiles",
        "London"
      ]
    }
  ],
  "events": [
    {
      "type": "status",
      "label": "Scanning public sources"
    },
    {
      "type": "hit",
      "hit": {
        "id": "ada-lovelace",
        "name": "Ada Lovelace",
        "headline": "Mathematician · London",
        "initials": "AL",
        "confidence": 82,
        "location": "London, United Kingdom",
        "tags": [
          "3 social profiles",
          "London"
        ]
      }
    },
    {
      "type": "done"
    }
  ]
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14curl https://deepsearch.app/api/v1/dossier \
  -H "Authorization: Bearer $DEEPSEARCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "person": {
          "name": "Ada Lovelace",
          "headline": "Mathematician · London",
          "confidence": 82,
          "tags": [
            "Computing pioneer"
          ]
        },
        "format": "json"
      }'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72{
  "object": "dossier_result",
  "request_id": "req_01HZY8N9M52JGQ7PC1X3TPEF5R",
  "metadata": {
    "api_version": "v1",
    "operation": "dossier",
    "request_id": "req_01HZY8N9M52JGQ7PC1X3TPEF5R",
    "generated_at": "2026-06-19T12:00:00.000Z"
  },
  "usage": {
    "metered": true,
    "percentageCharged": 9,
    "remainingPercent": 73,
    "resetAt": "2026-07-01T00:00:00.000Z",
    "source": "included",
    "credits": 1,
    "allowanceSource": "weekly",
    "cached": false
  },
  "cached": false,
  "dossier": {
    "summary": "Ada Lovelace was a 19th-century mathematician widely regarded as the first computer programmer.",
    "sections": {
      "identity": {
        "name": "Ada Lovelace",
        "age": null
      }
    },
    "sources": [
      {
        "id": "src-1",
        "position": 1,
        "url": "https://en.wikipedia.org/wiki/Ada_Lovelace",
        "title": "Ada Lovelace",
        "domain": "en.wikipedia.org"
      }
    ]
  },
  "events": [
    {
      "type": "section",
      "key": "identity",
      "data": {
        "name": "Ada Lovelace",
        "age": null
      }
    },
    {
      "type": "summary",
      "delta": "Ada Lovelace was a 19th-century mathematician "
    },
    {
      "type": "summary",
      "delta": "widely regarded as the first computer programmer."
    },
    {
      "type": "sources",
      "sources": [
        {
          "id": "src-1",
          "position": 1,
          "url": "https://en.wikipedia.org/wiki/Ada_Lovelace",
          "title": "Ada Lovelace",
          "domain": "en.wikipedia.org"
        }
      ]
    },
    {
      "type": "done"
    }
  ]
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15curl https://deepsearch.app/api/v1/chat \
  -H "Authorization: Bearer $DEEPSEARCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "person": {
          "name": "Ada Lovelace"
        },
        "messages": [
          {
            "role": "user",
            "content": "Summarize her public footprint."
          }
        ],
        "format": "json"
      }'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44{
  "object": "chat_result",
  "request_id": "req_01HZY8P8V1TXZ6YXMJ56ATJZ1J",
  "metadata": {
    "api_version": "v1",
    "operation": "chat",
    "request_id": "req_01HZY8P8V1TXZ6YXMJ56ATJZ1J",
    "generated_at": "2026-06-19T12:00:00.000Z"
  },
  "usage": {
    "metered": true,
    "percentageCharged": 1,
    "remainingPercent": 72,
    "resetAt": "2026-07-01T00:00:00.000Z",
    "source": "included",
    "credits": 1,
    "allowanceSource": "weekly"
  },
  "answer": "Ada Lovelace is best known for her notes on Babbage's Analytical Engine.",
  "related_questions": [
    "What did she publish?",
    "Who did she collaborate with?"
  ],
  "events": [
    {
      "type": "text",
      "delta": "Ada Lovelace is best known for "
    },
    {
      "type": "text",
      "delta": "her notes on Babbage's Analytical Engine."
    },
    {
      "type": "related",
      "questions": [
        "What did she publish?",
        "Who did she collaborate with?"
      ]
    },
    {
      "type": "done"
    }
  ]
}

1
2
3
4
5
6curl https://deepsearch.app/api/v1/reverse-image \
  -H "Authorization: Bearer $DEEPSEARCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "imageUrl": "https://upload.wikimedia.org/wikipedia/commons/a/a4/Ada_Lovelace_portrait.jpg"
      }'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21{
  "object": "reverse_image_result",
  "request_id": "req_01HZY8Q2RVIMG9F4X9J7Z1H3AB",
  "result": {
    "provider": "serpapi-lens",
    "matches": [
      {
        "url": "https://en.wikipedia.org/wiki/Ada_Lovelace",
        "title": "Ada Lovelace - Wikipedia",
        "sourceDomain": "en.wikipedia.org"
      }
    ],
    "similar": [
      {
        "imageUrl": "https://example.com/portrait-variant.jpg",
        "sourceUrl": "https://example.com/article",
        "sourceDomain": "example.com"
      }
    ]
  }
}

1
2
3
4
5
6curl https://deepsearch.app/api/v1/entity/search \
  -H "Authorization: Bearer $DEEPSEARCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "query": "Stripe"
      }'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21{
  "object": "entity_search_result",
  "request_id": "req_01HZY8R3ENTITYSRCH9F4X9J7Z1",
  "companies": [
    {
      "kind": "company",
      "id": "stripe-us-de",
      "name": "Stripe",
      "legalName": "Stripe, Inc.",
      "headline": "Payments · San Francisco · ~8000 employees",
      "initials": "ST",
      "confidence": 92,
      "jurisdiction": "us_de",
      "status": "active",
      "tags": [
        "Payments",
        "Private"
      ]
    }
  ]
}

1
2
3
4
5
6
7
8
9curl https://deepsearch.app/api/v1/entity/dossier \
  -H "Authorization: Bearer $DEEPSEARCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "company": {
          "name": "Stripe",
          "jurisdiction": "us_de"
        }
      }'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23{
  "object": "entity_dossier_result",
  "request_id": "req_01HZY8S4ENTITYDOSSIER9F4X9",
  "cached": false,
  "company": {
    "entityId": "stripe-us-de",
    "name": "Stripe",
    "legalName": "Stripe, Inc.",
    "status": "active",
    "registration": {
      "jurisdiction": "Delaware, US",
      "entityType": "C Corporation",
      "legalStatus": "Active"
    },
    "executives": [
      {
        "name": "Patrick Collison",
        "title": "CEO"
      }
    ],
    "summary": "Stripe is a payments company headquartered in San Francisco… [1]"
  }
}

1
2
3
4
5
6curl https://deepsearch.app/api/v1/vin \
  -H "Authorization: Bearer $DEEPSEARCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "vin": "1HGCM82633A004352"
      }'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26{
  "object": "vin_result",
  "request_id": "req_01HZY8T5VINLOOKUP9F4X9J7Z1",
  "cached": false,
  "vehicle": {
    "vin": "1HGCM82633A004352",
    "year": 2003,
    "make": "HONDA",
    "model": "Accord",
    "headline": "2003 HONDA Accord EX · Sedan/Saloon",
    "engine": {
      "cylinders": "6",
      "displacementL": "3",
      "fuelType": "Gasoline"
    },
    "recalls": [],
    "safety": {
      "airbags": [
        "Front (1st Row (Driver & Passenger))"
      ],
      "features": [],
      "ratings": []
    },
    "summary": "The 2003 Honda Accord is a midsize sedan… [1]"
  }
}