> ## Documentation Index > Fetch the complete documentation index at: https://commet.co/docs/llms.txt > Use this file to discover all available pages before exploring further. # Create API key > Create a full-access or restricted API key. Provide permissions to restrict access; the full key is returned only once. A restricted key with api_key: write may only create restricted keys with the same or fewer permissions, and they expire no later than the key that creates them. Create a full-access or restricted API key. Provide permissions to restrict access; the full key is returned only once. A restricted key with api\_key: write may only create restricted keys with the same or fewer permissions, and they expire no later than the key that creates them. ## OpenAPI ````yaml /openapi/en/rest/2026-08-27.json post /api-keys openapi: 3.1.0 info: title: Commet API version: '2026-08-27' description: Billing and payments API for SaaS and AI products. servers: - url: https://commet.co/api/v1 security: - ApiKeyAuth: [] tags: - name: Test Clock description: >- Simulate the passage of time in sandbox to test billing flows. Mirrors Stripe test clocks: forward-only and sandbox-only. - name: Customers - name: Subscriptions - name: Plans - name: Markets description: >- Reusable country groups for market-specific prices and selectable price variants. - name: Offers - name: Promo Codes - name: Features - name: Usage - name: Seats - name: Quota - name: Add-ons - name: Portal - name: Credit Packs - name: Plan Groups - name: Invoices - name: Payments description: >- One-time payments with no subscription or plan. Charge a customer's saved payment method off-session, or create a payment link the customer opens to pay. Tax, invoice, and receipt are handled automatically. - name: Transactions - name: Webhooks - name: API Keys - name: Payouts description: >- Withdraw available balance to your bank and manage the payout account (verification + destination bank accounts). - name: Provisioning description: >- Take ownership of an organization an agent provisioned headlessly. The agent holds the API keys from the start; a human claims the account through a claim link. paths: /api-keys: post: tags: - API Keys summary: Create API key description: >- Create a full-access or restricted API key. Provide permissions to restrict access; the full key is returned only once. A restricted key with api_key: write may only create restricted keys with the same or fewer permissions, and they expire no later than the key that creates them. operationId: create-api-key parameters: - name: Idempotency-Key in: header required: false description: >- Unique key used to safely retry this write for 24 hours without applying it twice. schema: type: string minLength: 1 maxLength: 200 - name: Commet-Version in: header required: false description: >- API version used by this reference. Send this header to select this contract explicitly. schema: type: string default: '2026-08-27' example: '2026-08-27' requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 expiresInDays: default: 365 type: integer exclusiveMinimum: 0 maximum: 9007199254740991 permissions: type: object properties: customer: anyOf: - maxItems: 2 type: array items: type: string const: read - type: array prefixItems: - type: string const: read - type: string const: write minItems: 2 maxItems: 2 - type: array prefixItems: - type: string const: write - type: string const: read minItems: 2 maxItems: 2 subscription: anyOf: - maxItems: 2 type: array items: type: string const: read - type: array prefixItems: - type: string const: read - type: string const: write minItems: 2 maxItems: 2 - type: array prefixItems: - type: string const: write - type: string const: read minItems: 2 maxItems: 2 invoice: anyOf: - maxItems: 2 type: array items: type: string const: read - type: array prefixItems: - type: string const: read - type: string const: write minItems: 2 maxItems: 2 - type: array prefixItems: - type: string const: write - type: string const: read minItems: 2 maxItems: 2 usage: anyOf: - maxItems: 2 type: array items: type: string const: read - type: array prefixItems: - type: string const: read - type: string const: write minItems: 2 maxItems: 2 - type: array prefixItems: - type: string const: write - type: string const: read minItems: 2 maxItems: 2 seat: anyOf: - maxItems: 2 type: array items: type: string const: read - type: array prefixItems: - type: string const: read - type: string const: write minItems: 2 maxItems: 2 - type: array prefixItems: - type: string const: write - type: string const: read minItems: 2 maxItems: 2 plan: anyOf: - maxItems: 2 type: array items: type: string const: read - type: array prefixItems: - type: string const: read - type: string const: write minItems: 2 maxItems: 2 - type: array prefixItems: - type: string const: write - type: string const: read minItems: 2 maxItems: 2 plan_group: anyOf: - maxItems: 2 type: array items: type: string const: read - type: array prefixItems: - type: string const: read - type: string const: write minItems: 2 maxItems: 2 - type: array prefixItems: - type: string const: write - type: string const: read minItems: 2 maxItems: 2 feature: anyOf: - maxItems: 2 type: array items: type: string const: read - type: array prefixItems: - type: string const: read - type: string const: write minItems: 2 maxItems: 2 - type: array prefixItems: - type: string const: write - type: string const: read minItems: 2 maxItems: 2 addon: anyOf: - maxItems: 2 type: array items: type: string const: read - type: array prefixItems: - type: string const: read - type: string const: write minItems: 2 maxItems: 2 - type: array prefixItems: - type: string const: write - type: string const: read minItems: 2 maxItems: 2 credit_pack: anyOf: - maxItems: 2 type: array items: type: string const: read - type: array prefixItems: - type: string const: read - type: string const: write minItems: 2 maxItems: 2 - type: array prefixItems: - type: string const: write - type: string const: read minItems: 2 maxItems: 2 offer: anyOf: - maxItems: 2 type: array items: type: string const: read - type: array prefixItems: - type: string const: read - type: string const: write minItems: 2 maxItems: 2 - type: array prefixItems: - type: string const: write - type: string const: read minItems: 2 maxItems: 2 promo_code: anyOf: - maxItems: 2 type: array items: type: string const: read - type: array prefixItems: - type: string const: read - type: string const: write minItems: 2 maxItems: 2 - type: array prefixItems: - type: string const: write - type: string const: read minItems: 2 maxItems: 2 market_group: anyOf: - maxItems: 2 type: array items: type: string const: read - type: array prefixItems: - type: string const: read - type: string const: write minItems: 2 maxItems: 2 - type: array prefixItems: - type: string const: write - type: string const: read minItems: 2 maxItems: 2 payment: anyOf: - maxItems: 2 type: array items: type: string const: read - type: array prefixItems: - type: string const: read - type: string const: write minItems: 2 maxItems: 2 - type: array prefixItems: - type: string const: write - type: string const: read minItems: 2 maxItems: 2 transaction: anyOf: - maxItems: 2 type: array items: type: string const: read - type: array prefixItems: - type: string const: read - type: string const: write minItems: 2 maxItems: 2 - type: array prefixItems: - type: string const: write - type: string const: read minItems: 2 maxItems: 2 payout: anyOf: - maxItems: 2 type: array items: type: string const: read - type: array prefixItems: - type: string const: read - type: string const: write minItems: 2 maxItems: 2 - type: array prefixItems: - type: string const: write - type: string const: read minItems: 2 maxItems: 2 test_clock: anyOf: - maxItems: 2 type: array items: type: string const: read - type: array prefixItems: - type: string const: read - type: string const: write minItems: 2 maxItems: 2 - type: array prefixItems: - type: string const: write - type: string const: read minItems: 2 maxItems: 2 organization: anyOf: - maxItems: 2 type: array items: type: string const: read - type: array prefixItems: - type: string const: read - type: string const: write minItems: 2 maxItems: 2 - type: array prefixItems: - type: string const: write - type: string const: read minItems: 2 maxItems: 2 api_key: anyOf: - maxItems: 2 type: array items: type: string const: read - type: array prefixItems: - type: string const: read - type: string const: write minItems: 2 maxItems: 2 - type: array prefixItems: - type: string const: write - type: string const: read minItems: 2 maxItems: 2 additionalProperties: false required: - name responses: '201': description: Success headers: X-Request-Id: $ref: '#/components/headers/RequestId' RateLimit-Limit: description: Maximum number of requests allowed in the current window. schema: type: string RateLimit-Remaining: description: Requests remaining in the current window. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CreatedApiKey' example: id: key_1a2b3c4d name: Local development apiKey: ck_example_not_a_real_api_key prefix: ck_example expiresAt: '2027-09-07T12:00:00.000Z' createdAt: '2026-09-07T12:00:00.000Z' object: api_key livemode: false '400': description: Bad request headers: X-Request-Id: $ref: '#/components/headers/RequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: type: validation_error code: validation_error message: The request contains an invalid parameter. doc_url: >- https://commet.co/docs/api-reference/2026-08-27/errors/validation_error.md '401': description: Unauthorized headers: X-Request-Id: $ref: '#/components/headers/RequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: type: authentication_error code: unauthorized message: A valid API key is required. doc_url: >- https://commet.co/docs/api-reference/2026-08-27/errors/unauthorized.md '403': description: Forbidden headers: X-Request-Id: $ref: '#/components/headers/RequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: type: authentication_error code: forbidden message: You do not have permission to perform this operation. doc_url: >- https://commet.co/docs/api-reference/2026-08-27/errors/forbidden.md '409': description: Conflict headers: X-Request-Id: $ref: '#/components/headers/RequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: type: conflict_error code: idempotency_in_progress message: >- A request with this idempotency key is still being processed. doc_url: >- https://commet.co/docs/api-reference/2026-08-27/errors/idempotency_in_progress.md '429': description: Too many requests headers: X-Request-Id: $ref: '#/components/headers/RequestId' RateLimit-Limit: description: Maximum number of requests allowed in the current window. schema: type: string RateLimit-Remaining: description: Requests remaining in the current window. schema: type: string RateLimit-Reset: description: Seconds until the rate limit window resets. schema: type: string Retry-After: description: Seconds to wait before retrying the request. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: type: rate_limit_error code: rate_limited message: >- Too many requests. Retry after the interval specified in the Retry-After header. doc_url: >- https://commet.co/docs/api-reference/2026-08-27/errors/rate_limited.md '500': description: Internal server error headers: X-Request-Id: $ref: '#/components/headers/RequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: type: internal_error code: internal_error message: An unexpected error occurred while processing the request. doc_url: >- https://commet.co/docs/api-reference/2026-08-27/errors/internal_error.md '503': description: Service unavailable headers: X-Request-Id: $ref: '#/components/headers/RequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: type: internal_error code: idempotency_unavailable message: >- Idempotency storage is temporarily unavailable. Retry with the same idempotency key. doc_url: >- https://commet.co/docs/api-reference/2026-08-27/errors/idempotency_unavailable.md x-codeSamples: - lang: typescript label: TypeScript source: >- import { Commet } from "@commet/node"; const commet = new Commet({ apiKey: "ck_xxx" }); const createdApiKey = await commet.apiKeys.create({ name: "example" }); - lang: python label: Python source: |- from commet import Commet commet = Commet("ck_xxx") created_api_key = commet.api_keys.create(name="example") - lang: go label: Go source: "client, err := commet.New(\"ck_xxx\")\nif err != nil {\n\tlog.Fatal(err)\n}\nctx := context.Background()\n\ncreatedApiKey, err := client.ApiKeys.Create(ctx, &commet.CreateApiKeyParams{\n\tName: \"example\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}" - lang: java label: Java source: >- import co.commet.Commet; import co.commet.params.CreateApiKeyParams; var commet = Commet.builder().apiKey("ck_xxx").build(); var createdApiKey = commet.apiKeys().create(CreateApiKeyParams.builder("example").build()); - lang: php label: PHP source: |- use Commet\Commet; $commet = new Commet('ck_xxx'); $createdApiKey = $commet->apiKeys->create(name: 'example'); components: headers: RequestId: description: >- Server-generated identifier that correlates this response with Platform logs. schema: type: string format: uuid schemas: CreatedApiKey: type: object properties: id: type: string name: type: string apiKey: type: string prefix: type: string expiresAt: type: string format: date-time createdAt: type: string format: date-time object: type: string const: api_key livemode: type: boolean required: - id - name - apiKey - prefix - expiresAt - createdAt - object - livemode additionalProperties: false ErrorResponse: type: object properties: error: type: object properties: type: type: string code: type: string message: type: string param: type: string details: {} doc_url: type: string required: - type - code - message - doc_url additionalProperties: false required: - error additionalProperties: false securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key ```` ## Related topics - [Create an API Key](/docs/create-api-key.md) - [CLI](/docs/cli.md) - [MCP Server](/docs/mcp-server.md) - [List API keys](/docs/api-reference/api-keys/list-api-keys.md) - [Delete API key](/docs/api-reference/api-keys/delete-api-key.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.