API Keys

Create a new API key

Generates a new workspace-scoped API key. The full key_value is returned only in this response — Audioscrape stores a SHA-256 hash and the prefix only, so save the raw key immediately on the client side. If you lose it, rotate the key.

Accepts either a session cookie or an existing API key as auth.

post/api/keys

Request

  • Base URL: https://www.audioscrape.com
  • URL: https://www.audioscrape.com/api/keys
  • Auth: HTTP bearer

Request body

expires_atstring date-time nullable

Optional: when this key stops working (RFC 3339). Omit for a key that never expires — the behaviour of every key issued before 2026-07-31.

key_namestring required

Human-readable label for the key. Stored verbatim; visible in the dashboard and in last_used audit logs. Recommended: identify the integration + environment, e.g. "acme-dev-connector-v1".

workspace_idinteger nullable

Optional: scope this key to a single workspace. If omitted, the key uses the user's current_workspace_id at each request (legacy behavior). To scope to a workspace, the caller must be a member of it.

Example request

{
  "expires_at": "2027-01-01T00:00:00Z",
  "key_name": "acme-dev-connector-v1",
  "workspace_id": 42
}

Response

Key created. key_value is shown in full here for the only time.

created_atstring nullable

RFC 3339 UTC timestamp.

expires_atstring nullable

When the key stops authenticating (RFC 3339). null = never expires, which is the case for every key issued before 2026-07-31.

idinteger required
key_namestring required

Human-readable label for the key (shown in the dashboard).

key_prefixstring required

Display-safe prefix of the key (first 12 characters + "..."). Always present. Use this to identify the key in logs and UIs.

key_valuestring nullable

The full bearer token, format sk_<base64(32 random bytes)>. Returned only in the response to POST /api/keys — Audioscrape stores only a SHA-256 hash, so list / delete endpoints cannot recover the raw value. Save it client-side immediately on creation.

last_usedstring nullable

RFC 3339 UTC timestamp of the most recent request that used this key. null if the key has never been used.

last_used_ipstring nullable

Source IP of the request described by last_used (as seen by our edge). null if the key has never been used or the IP was unavailable. Use it to spot a leaked key being used from somewhere unexpected.

workspace_idinteger nullable

Workspace this key is scoped to. null means the key follows the user's current_workspace_id at request time (legacy behavior).

Example response

{
  "created_at": "2026-05-16T08:30:00Z",
  "key_name": "acme-dev-connector-v1",
  "key_prefix": "sk_abc123def...",
  "key_value": "sk_abc123base64encodedrandombytes...",
  "last_used": "2026-05-16T08:30:00Z",
  "last_used_ip": "203.0.113.7",
  "workspace_id": 42
}

Changes

No recorded changes to this operation across all 1 revision of this API.