# Create API key

> Mints a key and returns it in full, once. `raw` is never retrievable again, so store it when you receive it. A key authenticated with an API key cannot grant scopes it does not itself hold.

`POST /api-keys`

**Auth:** API key or OAuth token

## Request body

- `name` (string) — ≥ 1 characters, ≤ 256 characters.
- `scopes` (string[]) — Default `["generate"]`. ≥ 1 items.

## Response

### 201 — API key created

- `data` (required, object)
  - `raw` (required, string)
  - `api_key` (required, object)
    - `id` (required, string)
    - `name` (required, string | null)
    - `key_preview` (required, string)
    - `user_id` (required, string)
    - `scopes` (required, string[])
    - `spending_limit` (required, string | null)
    - `spending_limit_period` (required, string | null) — One of: `"day"`, `"week"`, `"month"`.
    - `created_at` (required, string) — format: date-time.
    - `updated_at` (required, string) — format: date-time.

```json
{
  "data": {
    "raw": "string",
    "api_key": {
      "id": "string",
      "name": "string",
      "key_preview": "string",
      "user_id": "string",
      "scopes": [
        "generate"
      ],
      "spending_limit": "string",
      "spending_limit_period": "day",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}
```

### 400 — The request was rejected before anything was queued. `error.message` says what to change. A field that failed the schema, or one the endpoint does not take, is also listed in `error.issues`.

- `error` (required, object)
  - `code` (required, string) — `validation_error` for a body that failed validation, `invalid_json` for one that is not JSON. One of: `"validation_error"`, `"invalid_json"`.
  - `message` (required, string) — Every problem, in one sentence each, led by the field it is about.
  - `issues` (object[]) — One entry per field that failed the schema, and one per field the endpoint does not take.
    - `path` (required, (string | integer)[]) — Where the problem is, e.g. `["inputs", 0, "source"]`. Empty for the body as a whole.
    - `message` (required, string)

```json
{
  "error": {
    "code": "validation_error",
    "message": "count: Too big: expected number to be <=20. colour: Unknown field.",
    "issues": [
      {
        "path": [
          "count"
        ],
        "message": "Too big: expected number to be <=20"
      },
      {
        "path": [
          "colour"
        ],
        "message": "Unknown field."
      }
    ]
  }
}
```

## Request samples

### cURL

```bash
curl -X POST https://api.mynth.io/api-keys \
  -H "Authorization: Bearer $MYNTH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### JavaScript

```ts
const response = await fetch("https://api.mynth.io/api-keys", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.MYNTH_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});

const { data } = await response.json();
```

The full schema for this endpoint is in the [OpenAPI document](https://api.mynth.io/openapi.json).