---
title: "Create api key"
method: POST
path: "/api-keys"
tags: ["accounts"]
---

# Create api key

`POST /api-keys`

## Request body

- CreateApiKeyRequestBody
  - `description` string, nullable
  - `environment_id` string, nullable
  - `name` string, required
  - `rate_limit_percent` integer, nullable
  - `readonly` boolean, nullable

## Response `201`

Created

- object
  - `data` ApiKeyCreateResponseData, required
    - `created_at` string, date-time, required
    - `description` string, nullable
    - `environment` EnvironmentResponseData
      - `created_at` string, date-time, required
      - `environment_type` 'development' | 'production' | 'staging', required
      - `id` string, required
      - `name` string, required
      - `updated_at` string, date-time, required
    - `environment_id` string, nullable
    - `id` string, required
    - `integration` ApiKeyIntegrationResponseData
      - `id` string, required
      - `state` 'active' | 'created' | 'pending', required
      - `type` 'clerk' | 'metronome' | 'orb' | 'stripe' | 'unknown' | 'workos', required
    - `last_used_at` string, date-time, nullable
    - `name` string, required
    - `rate_limit_percent` integer, nullable
    - `readonly` boolean, required
    - `scopes` ApiKeyScope[], required
    - `secret` string, required
    - `updated_at` string, date-time, required
  - `params` object, required — Input parameters

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `500` — Server error

## Changes

> 125 revisions in range; 61 could not be searched.

- **2026-06-05** `d5456e7d9462` — 1 warning
  - added the new `metronome` enum value to the `data/integration/type` response property for the response status `201`
- **2026-05-29** `f35c9997b2fd` — 1 warning
  - added the new `workos` enum value to the `data/integration/type` response property for the response status `201`

[Change history](https://skmtc.dev/schematichq/apis/schematic-api/changes/api-keys/post.md)

---

[API](https://skmtc.dev/schematichq/apis/schematic-api.md) · [All operations](https://skmtc.dev/schematichq/apis/schematic-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/schematichq/schematic-api/revisions/0b238e148fa1/schema)