Create a new API key

api_keys.create(**kwargs) -> APIKey { metadata, spec, info }

POST/v1/account/api_keys

Creates a new API key on the account. Optionally grants the key access to one or more workspaces via initial_workspace_ids.

ParametersExpand Collapse

metadata: Metadata{ name, external_id, labels}

CreateAccountResourceMetadata contains the user-provided fields for creating an account-scoped resource. Read-only fields (id, account_id, profile_id) are excluded since they are set by the server.

Human-readable name for the resource (e.g., “Production API Key”, “Staging Workspace”)

external_id: String

External ID for the resource (e.g., a workflow ID from an external system)

labels: Hash[Symbol, String]

Arbitrary key-value pairs for categorization and filtering Examples: {“environment”: “production”, “team”: “platform”, “version”: “v2”}

spec: APIKeySpec { token, description, permissions, system_ }

Configuration for an API key.

token: String

The bearer token used to authenticate as this API key. Returned only on creation and rotation; subsequent reads omit this field.

description: String

Free-form description of what this API key is used for.

permissions: Array[String]

Permissions granted to this key. Each entry is a colon-separated verb:resource string (e.g. “manage:agents”). Currently has no enforced effect; reserved for future fine-grained authorization.

system_: bool

True when this key is managed by the system (e.g. the auto-provisioned global account key). System keys cannot be deleted but can be rotated.

initial_workspace_ids: Array[String]

Workspaces this API key will have access to on creation. Optional — a key can be created with no workspace access and granted later via AddAPIKeyWorkspace.

ReturnsExpand Collapse

class APIKey { metadata, spec, info }

An API key for the account. Use workspace-association RPCs to grant the key access to specific workspaces; a key with zero workspaces is valid but cannot access workspace-scoped resources.

metadata: AccountResourceMetadata { id, account_id, name, 3 more }

AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace.

id: String

Unique identifier for the resource (prefixed ULID, e.g., “apikey_01HXK…”)

account_id: String

Account this resource belongs to for multi-tenant isolation (prefixed ULID)

Human-readable name for the resource (e.g., “Customer Support Agent”, “Email Tool”) Required for resources that users interact with directly

profile_id: String

external_id: String

External ID for the resource (e.g., a workflow ID from an external system)

labels: Hash[Symbol, String]

Arbitrary key-value pairs for categorization and filtering Examples: {“environment”: “production”, “team”: “platform”, “version”: “v2”}

spec: APIKeySpec { token, description, permissions, system_ }

Configuration for an API key.

token: String

The bearer token used to authenticate as this API key. Returned only on creation and rotation; subsequent reads omit this field.

description: String

Free-form description of what this API key is used for.

permissions: Array[String]

Permissions granted to this key. Each entry is a colon-separated verb:resource string (e.g. “manage:agents”). Currently has no enforced effect; reserved for future fine-grained authorization.

system_: bool

True when this key is managed by the system (e.g. the auto-provisioned global account key). System keys cannot be deleted but can be rotated.

info: APIKeyInfo { created_by, workspaces_preview, workspaces_total }

created_by: Profile { metadata, spec }

A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces.

metadata: AccountResourceMetadata { id, account_id, name, 3 more }

AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace.

id: String

Unique identifier for the resource (prefixed ULID, e.g., “apikey_01HXK…”)

account_id: String

Account this resource belongs to for multi-tenant isolation (prefixed ULID)

Human-readable name for the resource (e.g., “Customer Support Agent”, “Email Tool”) Required for resources that users interact with directly

profile_id: String

external_id: String

External ID for the resource (e.g., a workflow ID from an external system)

labels: Hash[Symbol, String]

Arbitrary key-value pairs for categorization and filtering Examples: {“environment”: “production”, “team”: “platform”, “version”: “v2”}

spec: ProfileSpec { type, email, name }

Configuration for a profile.

type: :PROFILE_TYPE_UNSPECIFIED | :PROFILE_TYPE_USER | :PROFILE_TYPE_API_KEY | :PROFILE_TYPE_SYSTEM

Whether this profile represents a human user, an API key, or a system principal.

formatenum

One of the following:

:PROFILE_TYPE_UNSPECIFIED

:PROFILE_TYPE_USER

:PROFILE_TYPE_API_KEY

:PROFILE_TYPE_SYSTEM

email: String

Email address of the profile. Required and unique within an account for user profiles.

Display name (e.g., “Bobby Tables”).

workspaces_preview: Array[BareMetadata { id, name } ]

Up to a small number of workspaces this key has access to, intended for display (“Workspace 1, Workspace 2, and 4 more”). Use ListAPIKeyWorkspaces for the full paginated list.

id: String

Human-readable name of the referenced resource, populated by the server on reads for convenience. Absent on references to resources that do not have a name (e.g., objective tasks).

workspaces_total: Integer

Total number of workspaces this key has access to.

formatint32

Create a new API key

require "cadenya"

cadenya = Cadenya::Client.new(api_key: "My API Key")

api_key = cadenya.api_keys.create(metadata: {name: "name"}, spec: {})

puts(api_key)

{
  "metadata": {
    "id": "id",
    "accountId": "accountId",
    "name": "name",
    "profileId": "profileId",
    "externalId": "externalId",
    "labels": {
      "foo": "string"
    }
  },
  "spec": {
    "token": "token",
    "description": "description",
    "permissions": [
      "string"
    ],
    "system": true
  },
  "info": {
    "createdBy": {
      "metadata": {
        "id": "id",
        "accountId": "accountId",
        "name": "name",
        "profileId": "profileId",
        "externalId": "externalId",
        "labels": {
          "foo": "string"
        }
      },
      "spec": {
        "type": "PROFILE_TYPE_UNSPECIFIED",
        "email": "email",
        "name": "name"
      }
    },
    "workspacesPreview": [
      {
        "id": "id",
        "name": "name"
      }
    ],
    "workspacesTotal": 0
  }
}

Returns Examples

{
  "metadata": {
    "id": "id",
    "accountId": "accountId",
    "name": "name",
    "profileId": "profileId",
    "externalId": "externalId",
    "labels": {
      "foo": "string"
    }
  },
  "spec": {
    "token": "token",
    "description": "description",
    "permissions": [
      "string"
    ],
    "system": true
  },
  "info": {
    "createdBy": {
      "metadata": {
        "id": "id",
        "accountId": "accountId",
        "name": "name",
        "profileId": "profileId",
        "externalId": "externalId",
        "labels": {
          "foo": "string"
        }
      },
      "spec": {
        "type": "PROFILE_TYPE_UNSPECIFIED",
        "email": "email",
        "name": "name"
      }
    },
    "workspacesPreview": [
      {
        "id": "id",
        "name": "name"
      }
    ],
    "workspacesTotal": 0
  }
}