Api reference
Create API key
Authorization
BearerAuth AuthorizationBearer <token>
Search API key (ss_search_*) from the dashboard or keys API. Scopes (search, ingest, admin) are stored on the key; each route requires the matching scope.
In: header
Path Parameters
projectId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://loading/api/v1/projects/string/keys" \ -H "Content-Type: application/json" \ -d '{ "indexSlug": "string", "name": "string", "scopes": [ "search" ] }'{
"id": "string",
"name": "string",
"prefix": "string",
"scopes": [
"string"
],
"allowedOrigins": [
"string"
],
"rateLimitPerMinute": 0,
"expiresAt": "string",
"createdAt": "2019-08-24T14:15:22Z",
"rawKey": "string"
}{
"error": "string",
"message": "string",
"details": null
}{
"error": "string",
"message": "string",
"details": null
}{
"error": "string",
"message": "string",
"details": null
}Empty
List API keys in a project
Generate a browser-safe scoped search key
Derives an HMAC-signed scoped search key from the parent search API key supplied in the Authorization header. The returned key is safe to ship to browser clients — Typesense will enforce the embedded filter_by, expires_at, and cache_ttl on every request signed with it. Requires search scope on the parent key.