---
title: "Create a scoped API credential and return its secret once"
method: POST
path: "/v1/workspaces/{workspace_id}/api-credentials"
tags: ["Credentials"]
---

# Create a scoped API credential and return its secret once

`POST /v1/workspaces/{workspace_id}/api-credentials`

## Path parameters

- `workspace_id` string, required

## Headers

- `Idempotency-Key` string, required

## Request body

- CreateApiCredentialRequest
  - `name` string, required
  - `scopes` string[], required
  - `expires_at` string, date-time, nullable

## Response `201`

API credential created; secret is never returned again

- CreatedApiCredentialResponse
  - `request_id` string, required
  - `execution` Execution, required
    - `location` 'local' | 'cloud', required
    - `capability_id` string, nullable
    - `capability_version` string, nullable
  - `usage` Usage, required
    - `billable` boolean, required
    - `quantity` number, required
    - `unit` string, required
    - `credits` number
  - `warnings` string[], required
  - `data` CreatedApiCredential, required
    - `credential` ApiCredential, required
      - `id` string, required
      - `workspace_id` string, required
      - `name` string, required
      - `prefix` string, required — Non-secret display prefix
      - `scopes` string[], required
      - `created_at` string, date-time, required
      - `last_used_at` string, date-time, nullable, required
      - `expires_at` string, date-time, nullable, required
      - `revoked_at` string, date-time, nullable, required
    - `secret` string, required — One-time secret; only a hash is retained

## Other responses

- `default` — Standard Cerul error envelope

## Changes

- **2026-07-27** `c15615d54993` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/cerul-ai/apis/cerul-api/changes/v1/workspaces/:workspace_id/api-credentials/post.md)

---

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