Skip to main content
POST
/
user
/
api-keys
Create API key
curl --request POST \
  --url https://app.voxial.pt/api/user/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'
{
  "message": "API key created successfully.",
  "api_key": {
    "name": "Production API Key",
    "token": "1|abc123xyz789abcdef...",
    "created_at": "2025-01-08T10:30:00.000000Z"
  }
}
This endpoint generates a new API key for the authenticated user. Unlike the login endpoint which creates a session token, this creates a persistent API key that can be used for long-term API access.
This endpoint requires authentication. Use your existing API key or session token to create additional API keys.

​
Request Body

​
name
string
required
A name/label for the API key (e.g., “Production”, “Development”, “My App”)

​
Response

​
message
string
Success message
​
api_key
object
The created API key details
{
  "message": "API key created successfully.",
  "api_key": {
    "name": "Production API Key",
    "token": "1|abc123xyz789abcdef...",
    "created_at": "2025-01-08T10:30:00.000000Z"
  }
}

​
Example Request

curl -X POST https://app.voxial.pt/api/user/api-keys \
  -H "Authorization: Bearer YOUR_EXISTING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production API Key"
  }'
The API key token is only returned once. Make sure to store it securely. If you lose it, you’ll need to create a new one.

​
Managing API Keys

  • GET /user/api-keys - List all API keys for the authenticated user
  • DELETE /user/api-keys/ - Delete a specific API key