API ReferenceAPI Keys
Create API key
Authorization
bearerAuth AuthorizationBearer <token>
API key authentication. Include your API key in the Authorization header as Bearer rf_your_key.
In: header
Request Body
application/json
expires_at?string
Expiration date (RFC3339)
name*string
Descriptive name for the key
Length
1 <= lengthscopes?|null
Permitted scopes (extract, crawl, jobs)
[key: string]?never
Response Body
application/json
application/problem+json
curl -X POST "http://localhost:8080/api/v1/keys" \ -H "Content-Type: application/json" \ -d '{ "name": "string" }'{
"created_at": "string",
"expires_at": "string",
"id": "string",
"key": "string",
"key_prefix": "string",
"name": "string",
"scopes": [
"string"
]
}{
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}