API Keys

Endpointhttps://api.neuratel.ai

API key management for programmatic access.

List Master Keys

GET

https://api.neuratel.ai

/v1/api-keys/master

List all master API keys.

Super admin only.

List Master Keys › query Parameters

include_revoked

boolean

Default: false

List Master Keys › Responses

Successful Response

Paginated list of API keys.

object[] · required

object · required

Metadata for API key list responses.

GET/v1/api-keys/master

curl --request GET \
  --url https://api.neuratel.ai/v1/api-keys/master

shell

Example Responses

{
  "results": [
    {
      "id": "id",
      "name": "name",
      "description": "string",
      "key_type": "master",
      "prefix": "prefix",
      "scopes": [
        "admin:all"
      ],
      "created_at": "2024-08-25T15:00:00Z",
      "expires_at": "2024-08-25T15:00:00Z",
      "last_used_at": "2024-08-25T15:00:00Z",
      "is_active": true,
      "rate_limit_per_minute": 0,
      "allowed_ips": [
        "string"
      ],
      "organization_id": "string",
      "created_by": "created_by",
      "metadata": {},
      "revoked_at": "2024-08-25T15:00:00Z"
    }
  ],
  "metadata": {
    "total": 0,
    "count": 0,
    "include_revoked": true
  }
}

json

application/json

Create Master Key

POST

https://api.neuratel.ai

/v1/api-keys/master

Create a platform-wide master API key.

Super admin only. Master keys have full platform access.

⚠️ The secret is only shown once - save it securely!

Create Master Key › Request Body

Request to create an API key.

name

string · minLength: 1 · maxLength: 100 · required

key_type

string · enum

Type of API key.

Enum values:

master

organization

Default: organization

scopes

string[]

Enum values:

admin:all

admin:organizations

dashboard:view

agents:view

agents:create

agents:edit

agents:delete

agents:duplicate

Use preset: read_only, standard, full_access

rate_limit_per_minute

integer · min: 1 · max: 10000

Default: 60

IP whitelist

object

Create Master Key › Responses

Successful Response

API key response with secret (only on creation).

id

string · required

name

string · required

required

key_type

string · enum · required

Type of API key.

Enum values:

master

organization

prefix

string · required

Key prefix for identification (first 8 chars)

scopes

string[] · required

Enum values:

admin:all

admin:organizations

dashboard:view

agents:view

agents:create

agents:edit

agents:delete

agents:duplicate

created_at

string · date-time · required

required

is_active

boolean · required

rate_limit_per_minute

integer · required

required

created_by

string · required

key

string · required

Full API key (only shown once)

object

POST/v1/api-keys/master

curl --request POST \
  --url https://api.neuratel.ai/v1/api-keys/master \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "description": "string",
  "key_type": "organization",
  "scopes": [
    "admin:all"
  ],
  "scope_preset": "string",
  "expires_at": "2024-08-25T15:00:00Z",
  "rate_limit_per_minute": 60,
  "allowed_ips": [
    "string"
  ],
  "metadata": {}
}
'

shell

Example Request Body

{
  "name": "name",
  "description": "string",
  "key_type": "organization",
  "scopes": [
    "admin:all"
  ],
  "scope_preset": "string",
  "expires_at": "2024-08-25T15:00:00Z",
  "rate_limit_per_minute": 60,
  "allowed_ips": [
    "string"
  ],
  "metadata": {}
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "description": "string",
  "key_type": "master",
  "prefix": "prefix",
  "scopes": [
    "admin:all"
  ],
  "created_at": "2024-08-25T15:00:00Z",
  "expires_at": "2024-08-25T15:00:00Z",
  "last_used_at": "2024-08-25T15:00:00Z",
  "is_active": true,
  "rate_limit_per_minute": 0,
  "allowed_ips": [
    "string"
  ],
  "organization_id": "string",
  "created_by": "created_by",
  "metadata": {},
  "revoked_at": "2024-08-25T15:00:00Z",
  "key": "key"
}

json

application/json

List API Keys (Legacy)

GET

https://api.neuratel.ai

/v1/api-keys/organization

List all API keys for current organization.

Admin only. Super admins can specify organization_id to view any org's keys.

List API Keys (Legacy) › query Parameters

include_revoked

boolean

Default: false

organization_id

Target org ID (super admin only)

List API Keys (Legacy) › Responses

Successful Response

Paginated list of API keys.

object[] · required

object · required

Metadata for API key list responses.

GET/v1/api-keys/organization

curl --request GET \
  --url https://api.neuratel.ai/v1/api-keys/organization

shell

Example Responses

{
  "results": [
    {
      "id": "id",
      "name": "name",
      "description": "string",
      "key_type": "master",
      "prefix": "prefix",
      "scopes": [
        "admin:all"
      ],
      "created_at": "2024-08-25T15:00:00Z",
      "expires_at": "2024-08-25T15:00:00Z",
      "last_used_at": "2024-08-25T15:00:00Z",
      "is_active": true,
      "rate_limit_per_minute": 0,
      "allowed_ips": [
        "string"
      ],
      "organization_id": "string",
      "created_by": "created_by",
      "metadata": {},
      "revoked_at": "2024-08-25T15:00:00Z"
    }
  ],
  "metadata": {
    "total": 0,
    "count": 0,
    "include_revoked": true
  }
}

json

application/json

Create API Key (Legacy)

POST

https://api.neuratel.ai

/v1/api-keys/organization

Create an organization-scoped API key.

Admin only. Keys are scoped to the current organization. Super admins can specify organization_id to create keys for any org.

Scope presets:

read_only: Read access to all resources
standard: Read/write/execute (no admin)
full_access: All scopes including admin

⚠️ The secret is only shown once - save it securely!

Create API Key (Legacy) › query Parameters

organization_id

Target org ID (super admin only)

Create API Key (Legacy) › Request Body

Request to create an API key.

name

string · minLength: 1 · maxLength: 100 · required

key_type

string · enum

Type of API key.

Enum values:

master

organization

Default: organization

scopes

string[]

Enum values:

admin:all

admin:organizations

dashboard:view

agents:view

agents:create

agents:edit

agents:delete

agents:duplicate

Use preset: read_only, standard, full_access

rate_limit_per_minute

integer · min: 1 · max: 10000

Default: 60

IP whitelist

object

Create API Key (Legacy) › Responses

Successful Response

API key response with secret (only on creation).

id

string · required

name

string · required

required

key_type

string · enum · required

Type of API key.

Enum values:

master

organization

prefix

string · required

Key prefix for identification (first 8 chars)

scopes

string[] · required

Enum values:

admin:all

admin:organizations

dashboard:view

agents:view

agents:create

agents:edit

agents:delete

agents:duplicate

created_at

string · date-time · required

required

is_active

boolean · required

rate_limit_per_minute

integer · required

required

created_by

string · required

key

string · required

Full API key (only shown once)

object

POST/v1/api-keys/organization

curl --request POST \
  --url https://api.neuratel.ai/v1/api-keys/organization \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "description": "string",
  "key_type": "organization",
  "scopes": [
    "admin:all"
  ],
  "scope_preset": "string",
  "expires_at": "2024-08-25T15:00:00Z",
  "rate_limit_per_minute": 60,
  "allowed_ips": [
    "string"
  ],
  "metadata": {}
}
'

shell

Example Request Body

{
  "name": "name",
  "description": "string",
  "key_type": "organization",
  "scopes": [
    "admin:all"
  ],
  "scope_preset": "string",
  "expires_at": "2024-08-25T15:00:00Z",
  "rate_limit_per_minute": 60,
  "allowed_ips": [
    "string"
  ],
  "metadata": {}
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "description": "string",
  "key_type": "master",
  "prefix": "prefix",
  "scopes": [
    "admin:all"
  ],
  "created_at": "2024-08-25T15:00:00Z",
  "expires_at": "2024-08-25T15:00:00Z",
  "last_used_at": "2024-08-25T15:00:00Z",
  "is_active": true,
  "rate_limit_per_minute": 0,
  "allowed_ips": [
    "string"
  ],
  "organization_id": "string",
  "created_by": "created_by",
  "metadata": {},
  "revoked_at": "2024-08-25T15:00:00Z",
  "key": "key"
}

json

application/json

List API Keys

GET

https://api.neuratel.ai

/v1/api-keys

List all API keys for current organization.

Admin only. Super admins can specify organization_id to view any org's keys.

List API Keys › query Parameters

include_revoked

boolean

Default: false

organization_id

Target org ID (super admin only)

List API Keys › Responses

Successful Response

Paginated list of API keys.

object[] · required

object · required

Metadata for API key list responses.

GET/v1/api-keys

curl --request GET \
  --url https://api.neuratel.ai/v1/api-keys

shell

Example Responses

{
  "results": [
    {
      "id": "id",
      "name": "name",
      "description": "string",
      "key_type": "master",
      "prefix": "prefix",
      "scopes": [
        "admin:all"
      ],
      "created_at": "2024-08-25T15:00:00Z",
      "expires_at": "2024-08-25T15:00:00Z",
      "last_used_at": "2024-08-25T15:00:00Z",
      "is_active": true,
      "rate_limit_per_minute": 0,
      "allowed_ips": [
        "string"
      ],
      "organization_id": "string",
      "created_by": "created_by",
      "metadata": {},
      "revoked_at": "2024-08-25T15:00:00Z"
    }
  ],
  "metadata": {
    "total": 0,
    "count": 0,
    "include_revoked": true
  }
}

json

application/json

Create API Key

POST

https://api.neuratel.ai

/v1/api-keys

Create an organization-scoped API key.

Admin only. Keys are scoped to the current organization. Super admins can specify organization_id to create keys for any org.

Scope presets:

read_only: Read access to all resources
standard: Read/write/execute (no admin)
full_access: All scopes including admin

⚠️ The secret is only shown once - save it securely!

Create API Key › query Parameters

organization_id

Target org ID (super admin only)

Create API Key › Request Body

Request to create an API key.

name

string · minLength: 1 · maxLength: 100 · required

key_type

string · enum

Type of API key.

Enum values:

master

organization

Default: organization

scopes

string[]

Enum values:

admin:all

admin:organizations

dashboard:view

agents:view

agents:create

agents:edit

agents:delete

agents:duplicate

Use preset: read_only, standard, full_access

rate_limit_per_minute

integer · min: 1 · max: 10000

Default: 60

IP whitelist

object

Create API Key › Responses

Successful Response

API key response with secret (only on creation).

id

string · required

name

string · required

required

key_type

string · enum · required

Type of API key.

Enum values:

master

organization

prefix

string · required

Key prefix for identification (first 8 chars)

scopes

string[] · required

Enum values:

admin:all

admin:organizations

dashboard:view

agents:view

agents:create

agents:edit

agents:delete

agents:duplicate

created_at

string · date-time · required

required

is_active

boolean · required

rate_limit_per_minute

integer · required

required

created_by

string · required

key

string · required

Full API key (only shown once)

object

POST/v1/api-keys

curl --request POST \
  --url https://api.neuratel.ai/v1/api-keys \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "description": "string",
  "key_type": "organization",
  "scopes": [
    "admin:all"
  ],
  "scope_preset": "string",
  "expires_at": "2024-08-25T15:00:00Z",
  "rate_limit_per_minute": 60,
  "allowed_ips": [
    "string"
  ],
  "metadata": {}
}
'

shell

Example Request Body

{
  "name": "name",
  "description": "string",
  "key_type": "organization",
  "scopes": [
    "admin:all"
  ],
  "scope_preset": "string",
  "expires_at": "2024-08-25T15:00:00Z",
  "rate_limit_per_minute": 60,
  "allowed_ips": [
    "string"
  ],
  "metadata": {}
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "description": "string",
  "key_type": "master",
  "prefix": "prefix",
  "scopes": [
    "admin:all"
  ],
  "created_at": "2024-08-25T15:00:00Z",
  "expires_at": "2024-08-25T15:00:00Z",
  "last_used_at": "2024-08-25T15:00:00Z",
  "is_active": true,
  "rate_limit_per_minute": 0,
  "allowed_ips": [
    "string"
  ],
  "organization_id": "string",
  "created_by": "created_by",
  "metadata": {},
  "revoked_at": "2024-08-25T15:00:00Z",
  "key": "key"
}

json

application/json

Revoke API Key

DELETE

https://api.neuratel.ai

/v1/api-keys/{key_id}

Revoke an API key.

The key will be immediately invalidated.

Revoke API Key › path Parameters

key_id

string · required

Revoke API Key › Responses

Successful Response

No data returned

Rotate API Key

POST

https://api.neuratel.ai

/v1/api-keys/{key_id}/rotate

Rotate an API key with grace period.

Creates a new key and sets the old key to expire after the grace period. This allows time to update systems using the old key.

Args: key_id: ID of key to rotate grace_period_hours: Hours to keep old key valid (1-168, default 24)

⚠️ The new secret is only shown once - save it securely!

Rotate API Key › path Parameters

key_id

string · required

Rotate API Key › query Parameters

grace_period_hours

integer · min: 1 · max: 168

Default: 24

Rotate API Key › Responses

Successful Response

Response from key rotation.

old_key_id

string · required

object · required

API key response with secret (only on creation).

grace_period_ends

string · date-time · required

Old key remains valid until this time

POST/v1/api-keys/{key_id}/rotate

curl --request POST \
  --url https://api.neuratel.ai/v1/api-keys/:key_id/rotate

shell

Example Responses

{
  "old_key_id": "old_key_id",
  "new_key": {
    "id": "id",
    "name": "name",
    "description": "string",
    "key_type": "master",
    "prefix": "prefix",
    "scopes": [
      "admin:all"
    ],
    "created_at": "2024-08-25T15:00:00Z",
    "expires_at": "2024-08-25T15:00:00Z",
    "last_used_at": "2024-08-25T15:00:00Z",
    "is_active": true,
    "rate_limit_per_minute": 0,
    "allowed_ips": [
      "string"
    ],
    "organization_id": "string",
    "created_by": "created_by",
    "metadata": {},
    "revoked_at": "2024-08-25T15:00:00Z",
    "key": "key"
  },
  "grace_period_ends": "2024-08-25T15:00:00Z"
}

json

application/json

List Available Scopes

GET

https://api.neuratel.ai

/v1/api-keys/scopes

List all available API key scopes.

List Available Scopes › Responses

200

Successful Response

No data returned

Authentication Campaigns

Neuratel API

API Keys

Endpointhttps://api.neuratel.ai

API key management for programmatic access.

List Master Keys

GET

https://api.neuratel.ai

/v1/api-keys/master

List all master API keys.

Super admin only.

List Master Keys › query Parameters

include_revoked

boolean

Default: false

List Master Keys › Responses

Successful Response

Paginated list of API keys.

object[] · required

object · required

Metadata for API key list responses.

GET/v1/api-keys/master

curl --request GET \
  --url https://api.neuratel.ai/v1/api-keys/master

shell

Example Responses

{
  "results": [
    {
      "id": "id",
      "name": "name",
      "description": "string",
      "key_type": "master",
      "prefix": "prefix",
      "scopes": [
        "admin:all"
      ],
      "created_at": "2024-08-25T15:00:00Z",
      "expires_at": "2024-08-25T15:00:00Z",
      "last_used_at": "2024-08-25T15:00:00Z",
      "is_active": true,
      "rate_limit_per_minute": 0,
      "allowed_ips": [
        "string"
      ],
      "organization_id": "string",
      "created_by": "created_by",
      "metadata": {},
      "revoked_at": "2024-08-25T15:00:00Z"
    }
  ],
  "metadata": {
    "total": 0,
    "count": 0,
    "include_revoked": true
  }
}

json

application/json

Create Master Key

POST

https://api.neuratel.ai

/v1/api-keys/master

Create a platform-wide master API key.

Super admin only. Master keys have full platform access.

⚠️ The secret is only shown once - save it securely!

Create Master Key › Request Body

Request to create an API key.

name

string · minLength: 1 · maxLength: 100 · required

key_type

string · enum

Type of API key.

Enum values:

master

organization

Default: organization

scopes

string[]

Enum values:

admin:all

admin:organizations

dashboard:view

agents:view

agents:create

agents:edit

agents:delete

agents:duplicate

Use preset: read_only, standard, full_access

rate_limit_per_minute

integer · min: 1 · max: 10000

Default: 60

IP whitelist

object

Create Master Key › Responses

Successful Response

API key response with secret (only on creation).

id

string · required

name

string · required

required

key_type

string · enum · required

Type of API key.

Enum values:

master

organization

prefix

string · required

Key prefix for identification (first 8 chars)

scopes

string[] · required

Enum values:

admin:all

admin:organizations

dashboard:view

agents:view

agents:create

agents:edit

agents:delete

agents:duplicate

created_at

string · date-time · required

required

is_active

boolean · required

rate_limit_per_minute

integer · required

required

created_by

string · required

key

string · required

Full API key (only shown once)

object

POST/v1/api-keys/master

curl --request POST \
  --url https://api.neuratel.ai/v1/api-keys/master \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "description": "string",
  "key_type": "organization",
  "scopes": [
    "admin:all"
  ],
  "scope_preset": "string",
  "expires_at": "2024-08-25T15:00:00Z",
  "rate_limit_per_minute": 60,
  "allowed_ips": [
    "string"
  ],
  "metadata": {}
}
'

shell

Example Request Body

{
  "name": "name",
  "description": "string",
  "key_type": "organization",
  "scopes": [
    "admin:all"
  ],
  "scope_preset": "string",
  "expires_at": "2024-08-25T15:00:00Z",
  "rate_limit_per_minute": 60,
  "allowed_ips": [
    "string"
  ],
  "metadata": {}
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "description": "string",
  "key_type": "master",
  "prefix": "prefix",
  "scopes": [
    "admin:all"
  ],
  "created_at": "2024-08-25T15:00:00Z",
  "expires_at": "2024-08-25T15:00:00Z",
  "last_used_at": "2024-08-25T15:00:00Z",
  "is_active": true,
  "rate_limit_per_minute": 0,
  "allowed_ips": [
    "string"
  ],
  "organization_id": "string",
  "created_by": "created_by",
  "metadata": {},
  "revoked_at": "2024-08-25T15:00:00Z",
  "key": "key"
}

json

application/json

List API Keys (Legacy)

GET

https://api.neuratel.ai

/v1/api-keys/organization

List all API keys for current organization.

Admin only. Super admins can specify organization_id to view any org's keys.

List API Keys (Legacy) › query Parameters

include_revoked

boolean

Default: false

organization_id

Target org ID (super admin only)

List API Keys (Legacy) › Responses

Successful Response

Paginated list of API keys.

object[] · required

object · required

Metadata for API key list responses.

GET/v1/api-keys/organization

curl --request GET \
  --url https://api.neuratel.ai/v1/api-keys/organization

shell

Example Responses

{
  "results": [
    {
      "id": "id",
      "name": "name",
      "description": "string",
      "key_type": "master",
      "prefix": "prefix",
      "scopes": [
        "admin:all"
      ],
      "created_at": "2024-08-25T15:00:00Z",
      "expires_at": "2024-08-25T15:00:00Z",
      "last_used_at": "2024-08-25T15:00:00Z",
      "is_active": true,
      "rate_limit_per_minute": 0,
      "allowed_ips": [
        "string"
      ],
      "organization_id": "string",
      "created_by": "created_by",
      "metadata": {},
      "revoked_at": "2024-08-25T15:00:00Z"
    }
  ],
  "metadata": {
    "total": 0,
    "count": 0,
    "include_revoked": true
  }
}

json

application/json

Create API Key (Legacy)

POST

https://api.neuratel.ai

/v1/api-keys/organization

Create an organization-scoped API key.

Admin only. Keys are scoped to the current organization. Super admins can specify organization_id to create keys for any org.

Scope presets:

read_only: Read access to all resources
standard: Read/write/execute (no admin)
full_access: All scopes including admin

⚠️ The secret is only shown once - save it securely!

Create API Key (Legacy) › query Parameters

organization_id

Target org ID (super admin only)

Create API Key (Legacy) › Request Body

Request to create an API key.

name

string · minLength: 1 · maxLength: 100 · required

key_type

string · enum

Type of API key.

Enum values:

master

organization

Default: organization

scopes

string[]

Enum values:

admin:all

admin:organizations

dashboard:view

agents:view

agents:create

agents:edit

agents:delete

agents:duplicate

Use preset: read_only, standard, full_access

rate_limit_per_minute

integer · min: 1 · max: 10000

Default: 60

IP whitelist

object

Create API Key (Legacy) › Responses

Successful Response

API key response with secret (only on creation).

id

string · required

name

string · required

required

key_type

string · enum · required

Type of API key.

Enum values:

master

organization

prefix

string · required

Key prefix for identification (first 8 chars)

scopes

string[] · required

Enum values:

admin:all

admin:organizations

dashboard:view

agents:view

agents:create

agents:edit

agents:delete

agents:duplicate

created_at

string · date-time · required

required

is_active

boolean · required

rate_limit_per_minute

integer · required

required

created_by

string · required

key

string · required

Full API key (only shown once)

object

POST/v1/api-keys/organization

curl --request POST \
  --url https://api.neuratel.ai/v1/api-keys/organization \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "description": "string",
  "key_type": "organization",
  "scopes": [
    "admin:all"
  ],
  "scope_preset": "string",
  "expires_at": "2024-08-25T15:00:00Z",
  "rate_limit_per_minute": 60,
  "allowed_ips": [
    "string"
  ],
  "metadata": {}
}
'

shell

Example Request Body

{
  "name": "name",
  "description": "string",
  "key_type": "organization",
  "scopes": [
    "admin:all"
  ],
  "scope_preset": "string",
  "expires_at": "2024-08-25T15:00:00Z",
  "rate_limit_per_minute": 60,
  "allowed_ips": [
    "string"
  ],
  "metadata": {}
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "description": "string",
  "key_type": "master",
  "prefix": "prefix",
  "scopes": [
    "admin:all"
  ],
  "created_at": "2024-08-25T15:00:00Z",
  "expires_at": "2024-08-25T15:00:00Z",
  "last_used_at": "2024-08-25T15:00:00Z",
  "is_active": true,
  "rate_limit_per_minute": 0,
  "allowed_ips": [
    "string"
  ],
  "organization_id": "string",
  "created_by": "created_by",
  "metadata": {},
  "revoked_at": "2024-08-25T15:00:00Z",
  "key": "key"
}

json

application/json

List API Keys

GET

https://api.neuratel.ai

/v1/api-keys

List all API keys for current organization.

Admin only. Super admins can specify organization_id to view any org's keys.

List API Keys › query Parameters

include_revoked

boolean

Default: false

organization_id

Target org ID (super admin only)

List API Keys › Responses

Successful Response

Paginated list of API keys.

object[] · required

object · required

Metadata for API key list responses.

GET/v1/api-keys

curl --request GET \
  --url https://api.neuratel.ai/v1/api-keys

shell

Example Responses

{
  "results": [
    {
      "id": "id",
      "name": "name",
      "description": "string",
      "key_type": "master",
      "prefix": "prefix",
      "scopes": [
        "admin:all"
      ],
      "created_at": "2024-08-25T15:00:00Z",
      "expires_at": "2024-08-25T15:00:00Z",
      "last_used_at": "2024-08-25T15:00:00Z",
      "is_active": true,
      "rate_limit_per_minute": 0,
      "allowed_ips": [
        "string"
      ],
      "organization_id": "string",
      "created_by": "created_by",
      "metadata": {},
      "revoked_at": "2024-08-25T15:00:00Z"
    }
  ],
  "metadata": {
    "total": 0,
    "count": 0,
    "include_revoked": true
  }
}

json

application/json

Create API Key

POST

https://api.neuratel.ai

/v1/api-keys

Create an organization-scoped API key.

Admin only. Keys are scoped to the current organization. Super admins can specify organization_id to create keys for any org.

Scope presets:

read_only: Read access to all resources
standard: Read/write/execute (no admin)
full_access: All scopes including admin

⚠️ The secret is only shown once - save it securely!

Create API Key › query Parameters

organization_id

Target org ID (super admin only)

Create API Key › Request Body

Request to create an API key.

name

string · minLength: 1 · maxLength: 100 · required

key_type

string · enum

Type of API key.

Enum values:

master

organization

Default: organization

scopes

string[]

Enum values:

admin:all

admin:organizations

dashboard:view

agents:view

agents:create

agents:edit

agents:delete

agents:duplicate

Use preset: read_only, standard, full_access

rate_limit_per_minute

integer · min: 1 · max: 10000

Default: 60

IP whitelist

object

Create API Key › Responses

Successful Response

API key response with secret (only on creation).

id

string · required

name

string · required

required

key_type

string · enum · required

Type of API key.

Enum values:

master

organization

prefix

string · required

Key prefix for identification (first 8 chars)

scopes

string[] · required

Enum values:

admin:all

admin:organizations

dashboard:view

agents:view

agents:create

agents:edit

agents:delete

agents:duplicate

created_at

string · date-time · required

required

is_active

boolean · required

rate_limit_per_minute

integer · required

required

created_by

string · required

key

string · required

Full API key (only shown once)

object

POST/v1/api-keys

curl --request POST \
  --url https://api.neuratel.ai/v1/api-keys \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "description": "string",
  "key_type": "organization",
  "scopes": [
    "admin:all"
  ],
  "scope_preset": "string",
  "expires_at": "2024-08-25T15:00:00Z",
  "rate_limit_per_minute": 60,
  "allowed_ips": [
    "string"
  ],
  "metadata": {}
}
'

shell

Example Request Body

{
  "name": "name",
  "description": "string",
  "key_type": "organization",
  "scopes": [
    "admin:all"
  ],
  "scope_preset": "string",
  "expires_at": "2024-08-25T15:00:00Z",
  "rate_limit_per_minute": 60,
  "allowed_ips": [
    "string"
  ],
  "metadata": {}
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "description": "string",
  "key_type": "master",
  "prefix": "prefix",
  "scopes": [
    "admin:all"
  ],
  "created_at": "2024-08-25T15:00:00Z",
  "expires_at": "2024-08-25T15:00:00Z",
  "last_used_at": "2024-08-25T15:00:00Z",
  "is_active": true,
  "rate_limit_per_minute": 0,
  "allowed_ips": [
    "string"
  ],
  "organization_id": "string",
  "created_by": "created_by",
  "metadata": {},
  "revoked_at": "2024-08-25T15:00:00Z",
  "key": "key"
}

json

application/json

Revoke API Key

DELETE

https://api.neuratel.ai

/v1/api-keys/{key_id}

Revoke an API key.

The key will be immediately invalidated.

Revoke API Key › path Parameters

key_id

string · required

Revoke API Key › Responses

Successful Response

No data returned

Rotate API Key

POST

https://api.neuratel.ai

/v1/api-keys/{key_id}/rotate

Rotate an API key with grace period.

Creates a new key and sets the old key to expire after the grace period. This allows time to update systems using the old key.

Args: key_id: ID of key to rotate grace_period_hours: Hours to keep old key valid (1-168, default 24)

⚠️ The new secret is only shown once - save it securely!

Rotate API Key › path Parameters

key_id

string · required

Rotate API Key › query Parameters

grace_period_hours

integer · min: 1 · max: 168

Default: 24

Rotate API Key › Responses

Successful Response

Response from key rotation.

old_key_id

string · required

object · required

API key response with secret (only on creation).

grace_period_ends

string · date-time · required

Old key remains valid until this time

POST/v1/api-keys/{key_id}/rotate

curl --request POST \
  --url https://api.neuratel.ai/v1/api-keys/:key_id/rotate

shell

Example Responses

{
  "old_key_id": "old_key_id",
  "new_key": {
    "id": "id",
    "name": "name",
    "description": "string",
    "key_type": "master",
    "prefix": "prefix",
    "scopes": [
      "admin:all"
    ],
    "created_at": "2024-08-25T15:00:00Z",
    "expires_at": "2024-08-25T15:00:00Z",
    "last_used_at": "2024-08-25T15:00:00Z",
    "is_active": true,
    "rate_limit_per_minute": 0,
    "allowed_ips": [
      "string"
    ],
    "organization_id": "string",
    "created_by": "created_by",
    "metadata": {},
    "revoked_at": "2024-08-25T15:00:00Z",
    "key": "key"
  },
  "grace_period_ends": "2024-08-25T15:00:00Z"
}

json

application/json

List Available Scopes

GET

https://api.neuratel.ai

/v1/api-keys/scopes

List all available API key scopes.

List Available Scopes › Responses

200

Successful Response

No data returned

Authentication Campaigns