Create API Key

POST

/api/v1/keys

• Production

Create a new API key. Requires an internal or enterprise API key. Returns the generated key string — save it, it cannot be retrieved later.

Authorizations

• ApiKeyAuth

Request Body ^required

object

Example

{
  "name": "My App",
  "plan": "free"
}

Responses

200

Successful calculation

object

ok

boolean

Example

true

data

object

Example

{
  "ok": true,
  "data": {
    "apiKey": "aw_free_a1b2c3d4e5f6a1b2c3d4e5f6",
    "name": "My App",
    "plan": "free",
    "rateLimit": 10
  }
}

400

Validation error

Example

{
  "ok": false,
  "error": {
    "code": "INVALID_INPUT",
    "message": "Validation failed: date: Date must be YYYY-MM-DD",
    "details": [
      {
        "path": "date",
        "message": "Date must be YYYY-MM-DD"
      }
    ]
  }
}

401

Missing or invalid API key

Example

{
  "ok": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "Invalid API key"
  }
}