POST
/
extract
/
search
curl --request POST \
  --url https://gateway.allstream.ai/api/openapi/v1/extract/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "q": "chatgpt",
  "start": 0,
  "num": 100,
  "hl": "en",
  "gl": "US",
  "cr": "US",
  "lr": "en",
  "timeout": 3000
}'
{
  "requestId": "ecfceb9e-bdfb-4d16-8aef-fe5ee79db995",
  "code": 0,
  "errorCode": 200,
  "message": "Success",
  "timestamp": 1747365508926,
  "data": {
    "knowledgePanel": null,
    "location": {
      "htmlLang": "en"
    },
    "peopleAlsoAsk": [
      {
        "answer": "In summary, GPT-4 excels in versatility, integration, and overall accuracy, while Claude offers strengths in handling extensive texts, providing empathetic responses, and being more cost-effective for large-scale use.May 31, 2024",
        "question": "claude",
        "title": "Claude or GPT 4o? | by Rohit Bansal | Medium",
        "url": null
      },
      {
        "answer": "Claude excels at complex reasoning, writing code, and generating in-depth content across various fields. You can use Claude to brainstorm ideas, get answers to questions, and even analyse images.",
        "question": "Is Claude better than GPT?",
        "title": "What is Claude AI Best For? Key Strengths and Use Cases Explained",
        "url": null
      }
    ],
    "relatedSearches": [
      {
        "query": "Claude ai"
      },
      {
        "query": "Claude AI login"
      }
    ],
    "results": [
      {
        "date": "",
        "displayLink": "https://claude.ai",
        "domain": "claude.ai",
        "favicon": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABwAAAAcCAMAAABF0y+mAAAAJFBMVEVHcEzZd1fZd1fZd1fZd1fad1jZd1fZd1fZd1fZd1fZd1fZd1deZDooAAAADHRSTlMA//F3mhLfyjpWsiMDGU5mAAABH0lEQVQokXVSWXbEIAzDuw33v28FJCnpTP3BA6+yRGvbLK39a0F9RUvHZ5CIazZwkm+VpCi1nZP1GpJEnq2NdabzU594N0XpzInRhq/7jvm8wsOjFfVmcQG4guTWZKYL8HSiA1XFHDjgHMqCpKfpNPgIXiZVVvSJ9yazOJARxBiYf/ZMoIUxrYGjRHs/di2nbdzDZxIb1maPriold3QlyFJCAonMd08A7/WhkN19PWDolSeiXU7URWPm8S3ewMCuvGpB+kigVXvWZKlgIVycF0Hjl6DIoVRCGKz9pE8W0QKXkgkIEmjzUDuh11TSuVkn348DLHs1Y7/kzTi+ksX8GLn0wBRrdvCQS949C43fstj6FhfM8Unfqqwv3gf3+/kDMJgHC0kwnjEAAAAASUVORK5CYII=",
        "link": "https://claude.ai/",
        "realPosition": 1,
        "sitelinks": {
          "inline": [],
          "table": [
            {
              "link": "https://claude.ai/download",
              "snippet": "Download Claude for your desktop or mobile device.",
              "title": "Download Claude Desktop"
            }
          ]
        },
        "snippet": "Claude is a next generation AI assistant built by Anthropic and trained to be safe, accurate, and secure to help you do your best work. · Create with Claude.",
        "snippetHighlightedWords": [
          "Claude",
          "Claude"
        ],
        "source": "Claude",
        "title": "Claude"
      }
    ]
  }
}

Authorizations

x-api-key
string
header
required

Body

application/json
q
string
required

Search query

start
integer
default:
0

Start index for pagination

num
integer
default:
100

Number of results to return

hl
string
default:
en

Host language

gl
string
default:
US

Geolocation

cr
string

Country restrict

lr
string

Language restrict

timeout
integer
default:
25000

Timeout in milliseconds

Response

200 - application/json
Success
requestId
string
required

Unique identifier for the request

code
integer
required

Response code indicating the status of the request

timestamp
integer
required

ISO 8601 formatted timestamp of when the request was processed

data
object
required

Response data object containing search results

errorCode
integer

Error code details, if applicable

message
string

Response message