Skip to main content
POST
cURL

Get Your Vizlook API Key

Sign up and receive $10 free credit.

Authorizations

x-api-key
string
header
required

API key must be provided via x-api-key header.

Body

application/json
query
string
required

The query to answer.

Example:

"What is ChatGPT?"

stream
boolean

Enable streaming mode. If true, the response is returned as a server-sent events (SSE) stream.

Example:

true

contentOptions
object

Configure what answer citations include.

Response

200 - application/json

Successful response

answer
string

The generated answer based on search results. if no search results, return empty string "".

Example:

"ChatGPT is an artificial intelligence (AI) chatbot developed by OpenAI and released in 2022. It is a generative AI tool that allows users to interact with it in a way that simulates natural conversation, responding to questions and requests."

citations
object[]

Search results used to generate the answer.

dollarCost
object

Dollar cost of the request.