Create a custom index

A custom index is your own list of URLs, searched with the same relevance model as the news index: pass its id as index to POST /v1/search. Pay as you go allows 3 indexes and 100 URLs; the Monthly credit plan 50 and 10,000; Enterprise, unlimited.

post/v1/indexes

Request

  • Base URL: https://api.typesearch.ai
  • URL: https://api.typesearch.ai/v1/indexes
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Request body

namestring required

Response

The index that was created.

idstring required
object'index' required
namestring required
status'active' | 'paused' required

paused: no credit left, so it is not re-read (nor billed) until there is.

cost_per_day_usdnumber required

What its URLs cost per day right now (US$2.00 per 1,000 URLs per month, a thirtieth per day).

last_read_atstring nullable required
created_atstring required
updated_atstring required

Changes

No recorded changes to this operation across all 1 revision of this API.