Create a new API key

POST

/api-keys

Generates a new API key for the authenticated user. The API key is automatically
generated and can be used for API authentication. An optional description and
expiration date can be provided.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.perfectworks.io/api/v0/api-keys' \
--header 'Content-Type: application/json' \
--data-raw '{
    "description": "Production API key for mobile app",
    "expireAt": "2025-12-31T23:59:59.000Z"
}'

Response Example

201 - Example 1

{
    "success": true,
    "message": "Operation completed successfully",
    "data": {
        "id": "123",
        "name": "Example"
    }
}

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Examples

Responses

🟢201Created

application/json

API key created successfully

Body

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error

Modified at 2025-08-22 18:48:44

Convert file to different format

List user's API keys