Create a search from natural language text

POST

https://api.clay.com/public/v0

searches

curl --request POST \
  --url https://api.clay.com/public/v0/searches \
  --header 'Content-Type: application/json' \
  --header 'clay-api-key: <api-key>' \
  --data '
{
  "query": "<string>"
}
'

{
  "search_id": "<string>"
}

Authorizations

clay-api-key

string

header

required

Personal API key tied to your Clay user. Create one under Settings → Account in the Clay app.

Body

application/json

Body

query

string

required

Minimum string length: 1

source_type

enum<string>

required

Available options:

people,

companies

Response

200

search_id

string

required

Advance the search iterator and return the next page of resultsReturns the next page of records for an existing search.

Create a search from natural language text

curl --request POST \
  --url https://api.clay.com/public/v0/searches \
  --header 'Content-Type: application/json' \
  --header 'clay-api-key: <api-key>' \
  --data '
{
  "query": "<string>"
}
'

{
  "search_id": "<string>"
}