Get a custom index

get/v1/indexes/{id}

Request

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

Response

The index.

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.