Create API Key

Beta

POST/v1/auth/api-keys

Idempotent with Idempotency-Key header. Learn more

Creates an API key to authenticate API requests.

The secret key is returned once and cannot be retrieved later, so you should store it securely. We provide some recommendations on how you can manage your API keys.

Role type requiredValues:admin

Only API keys or agents whose role has this type can call this endpoint.

include[]optional arrayenumValues:rolerole.permissions

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

role_idstring

ID of the role to assign to the API key.

The role determines the permissions of requests authenticated with the key.

namestring

Human-readable name for the API key.

expires_atoptional string (date-time)

When the key expires and stops authenticating requests.

If omitted, the key never expires.

objectstringenumValues:created_api_key

Resource type identifier.

api_key_secretstring

Full secret value.

Returned once and cannot be retrieved later. Learn more about managing your API keys.

api_key_infoapi_key

API key metadata.

idstring

API key ID.

objectstringenumValues:api_key

Resource type identifier.

namestring

Human-readable name for the API key.

redacted_valuestring

Redacted key value safe for display.

The key's prefix followed by its last four characters, e.g. aug_sk_prod_****hjt4.

roleroleExpandablenullable

Role assigned to the key, which determines the permissions of requests made with it.

idstring

Role ID.

objectstringenumValues:role

Resource type identifier.

namestring

Display name, unique within the account.

typestringenumValues:adminuserscanner

The kind of role.

The role's type is sometimes used to gate special behaviors and to restrict some actions to only certain types of roles. For example, only roles with the type admin can create and manage API keys.

admin: full administrative access, including managing API keys.
user: a custom role tailored to a specific need (its permissions are defined explicitly). Roles created through the API always have this type.
scanner: a role for scanning-station operators.
sales_rep: a role for sales representatives.
agent: a role assigned to an automated agent rather than a person.

ownerownernullable

Provenance of this role.

System-owned roles are global defaults shared across all accounts and cannot be modified or deleted; account-owned roles are custom roles created by that account.

Always returned as null in this endpoint.

permissionsarray of stringExpandablenullable

Permissions granted by this role, in {domain}:{action} format, such as customers:read.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

last_used_atstring (date-time)nullable

When the key was last used to authenticate a request.

Updated at most once every 24 hours, so it may lag the key's most recent use. null if the key has never been used.

expires_atstring (date-time)nullable

When the key expires and stops authenticating.

null if the key never expires.

revoked_atstring (date-time)nullable

When the key's revocation takes effect.

A future timestamp means revocation was scheduled (for example, during rotation) and the key continues to authenticate requests until that time. null if the key has not been revoked.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

201

Successful response for Create API Key

Create API Key

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const createdAPIKey = await client.auth.apiKeys.create({
  name: 'Production API Key',
  role_id: 'rl_01c16d2eb637c0d1f3a372937c',
});

console.log(createdAPIKey.api_key_info);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const createdAPIKey = await client.auth.apiKeys.create({
  name: 'Production API Key',
  role_id: 'rl_01c16d2eb637c0d1f3a372937c',
});

console.log(createdAPIKey.api_key_info);

201 example

{
  "object": "created_api_key",
  "api_key_secret": "aug_sk_prod_RhxFDvTdDnb0bgtcoA5P79_60EmH4h9j9ZldsuU9XyngXlpu8NqdIlGTQw8OM8cGeCadyhjtr",
  "api_key_info": {
    "id": "apke_01fba3a7db3996e3b3b1a07e00",
    "object": "api_key",
    "name": "Production API Key",
    "redacted_value": "aug_sk_prod_****hjt4",
    "role": {
      "id": "rl_01c16d2eb637c0d1f3a372937c",
      "object": "role",
      "name": "Admin",
      "type": "admin",
      "owner": null,
      "permissions": [
        "customers:create",
        "customers:read",
        "customers:update",
        "customers:delete"
      ],
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "last_used_at": "2026-05-10T00:23:00Z",
    "expires_at": "2026-06-10T00:00:00Z",
    "revoked_at": null,
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  }
}

{
  "object": "created_api_key",
  "api_key_secret": "aug_sk_prod_RhxFDvTdDnb0bgtcoA5P79_60EmH4h9j9ZldsuU9XyngXlpu8NqdIlGTQw8OM8cGeCadyhjtr",
  "api_key_info": {
    "id": "apke_01fba3a7db3996e3b3b1a07e00",
    "object": "api_key",
    "name": "Production API Key",
    "redacted_value": "aug_sk_prod_****hjt4",
    "role": {
      "id": "rl_01c16d2eb637c0d1f3a372937c",
      "object": "role",
      "name": "Admin",
      "type": "admin",
      "owner": null,
      "permissions": [
        "customers:create",
        "customers:read",
        "customers:update",
        "customers:delete"
      ],
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "last_used_at": "2026-05-10T00:23:00Z",
    "expires_at": "2026-06-10T00:00:00Z",
    "revoked_at": null,
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  }
}

Create API Key

Authorization

Query Parameters

Request Body

Returns

Responses