API Keys

Create, list, and revoke API keys for programmatic access.

createApiKey

Create a new API key for programmatic access. The secret is only returned once on creation - save it securely.

POST

Usage:

const result = await swirls.client.apiKeys.createApiKey({
  name: '...',
})

Input:

Output:

listApiKeys

List all API keys for the current user

GET

Usage:

const result = await swirls.client.apiKeys.listApiKeys({})

Input:

revokeApiKey

Revoke an API key. This immediately invalidates the key and cannot be undone.

POST

Usage:

const result = await swirls.client.apiKeys.revokeApiKey({
  apiKeyId: '...',
})

Input:

Output: