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.

include[]optional arrayenumValues:rolerole.permissions

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

role_idstring

Role ID assigned to the API key.

namestring

Human-readable name for the API key.

expires_atoptional string (date-time)

Expiration timestamp. If not set, the key does not expire.

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_infoobject

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.

roleobjectExpandablenullable

Assigned role.

idstring

Role ID.

objectstringenumValues:role

Resource type identifier.

namestring

Display name.

typestringenumValues:adminuserscanner

Role type code.

The role's type is sometimes used to gate special behaviors in the frontend 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.

ownerobjectnullable

Owner of this resource.

Always returned as null in this endpoint.

permissionsarray of stringExpandablenullable

Permissions in {domain}:{action} format.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

last_used_atstring (date-time)nullable

Last used timestamp.

expires_atstring (date-time)nullable

Expiration timestamp.

revoked_atstring (date-time)nullable

Revocation 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"
    },
    "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"
  }
}

{
  "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"
    },
    "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"
  }
}

Create API Key

Query Parameters

Request Body

Returns

Responses