POST /v1/apikeys — Create PIN API Key

Generate a new user-scoped API key for authenticating with the PIN API. You can assign a custom name to distinguish keys. The full key value is returned only in this response and cannot be retrieved later.

Endpoint

POST /v1/apikeys Authentication: Bearer API key

Request body

string

default:"default"

Human-readable name for the new key.

Response

string

Unique key identifier.

string

Name assigned to the key.

string

Full plaintext API key. Store it immediately; it will not be shown again.

string

ISO 8601 timestamp when the key was created.

Example

curl -X POST http://localhost:8001/v1/apikeys \
  -H "Authorization: Bearer $ARIA_PIN_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"ci-deploy"}'

{
  "id": "key_9xYz2AbC3dE4",
  "name": "ci-deploy",
  "key": "ak_live_51HbN9xL5wR8fGqJ3...",
  "created_at": "2025-02-08T11:45:00Z"
}

Use the create API key endpoint to generate a new API key for programmatic access. Provide a name to identify the key. The full key value is returned only once and cannot be retrieved again.

Endpoint

POST /v1/apikeys

Authentication

Requires a valid Authorization: Bearer <jwt-or-api-key> header.

Request Body

string

required

Human-readable name for the new API key.

Response

string

Unique identifier for the created API key.

string

The name provided in the request.

string

The full API key value. This is shown only once; store it securely.

curl -X POST https://ariapin.example.com:8001/v1/apikeys \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." \
  -H "Content-Type: application/json" \
  -d '{"name":"production"}'

{
  "code": 0,
  "data": {
    "id": "key_xyz",
    "name": "production",
    "key": "pin_live_abc123..."
  },
  "message": ""
}

PIN API

ROUTER API

AGENT API

POST /v1/apikeys — Create PIN API Key

Endpoint

Request body

Response

Example

Endpoint

Authentication

Request Body

Response

​Endpoint

​Request body

​Response

​Example

​Endpoint

​Authentication

​Request Body

​Response

Endpoint

Request body

Response

Example

Endpoint

Authentication

Request Body

Response