Search

Search the web and return ranked results with extracted page content. Perplexity Search API-compatible.

Authorization

bearerAuth

AuthorizationBearer <token>

Bearer token authentication using API keys

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

model?string

ID of the search model to use. Defaults to perplexity/perplexity-search, or perplexity/perplexity-search-fast when search_type is fast.

query*|array<>

Search query, or up to 5 related queries that are searched independently and billed as one request.

search_type?string

Perplexity search type. "web" and "fast" select perplexity-search and perplexity-search-fast; "people" is not supported yet.

Value in"web" | "fast" | "people"

max_results?integer

Maximum number of results to return. Defaults to 10.

Range1 <= value <= 50

max_tokens?integer

Maximum total tokens of extracted content across all results.

Range0 < value <= 1000000

max_tokens_per_page?integer

Maximum tokens of extracted content per result.

Range0 < value <= 1000000

search_context_size?string

How much page content to extract per result.

Value in"low" | "medium" | "high"

country?string

ISO 3166-1 alpha-2 country code for regional results.

Length2 <= length <= 2

search_language_filter?array<string>

ISO 639-1 language codes to restrict results to.

Itemsitems <= 20

search_domain_filter?array<string>

Domains to restrict results to, or to exclude with a "-" prefix.

Itemsitems <= 20

search_recency_filter?string

Only return results published within this period.

Value in"hour" | "day" | "week" | "month" | "year"

search_after_date_filter?string

Match^\d{1,2}\/\d{1,2}\/\d{4}$

search_before_date_filter?string

Match^\d{1,2}\/\d{1,2}\/\d{4}$

last_updated_after_filter?string

Match^\d{1,2}\/\d{1,2}\/\d{4}$

last_updated_before_filter?string

Match^\d{1,2}\/\d{1,2}\/\d{4}$

Response Body

`application/json`

curl -X POST "https://example.com/v1/search" \  -H "Content-Type: application/json" \  -d '{    "query": "latest developments in open-source LLMs"  }'

{
  "id": "string",
  "model": "string",
  "results": [
    {
      "title": "string",
      "url": "string",
      "snippet": "string",
      "date": "string",
      "last_updated": "string"
    }
  ],
  "server_time": "string"
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

Search

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

402application/json

403application/json

404application/json

408application/json

410application/json

413application/json

415application/json

429application/json

500application/json

502application/json

503application/json

504application/json

529application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`