Create API Key
POST /api/v1/api-keys/
Create a new API key for programmatic access to the Parsify API.
Authentication
Requires an API key with api_keys:write scope, or a dashboard session. Pass via the X-API-Key header.
Request
Content type: application/json
Body Parameters
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | A descriptive name for the API key. |
scopes | array of strings | Yes | List of permission scopes to grant (e.g. documents:read, jobs:read). |
Response
Status: 201 Created
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Production Integration",
"scopes": ["documents:read", "documents:write", "jobs:read"],
"key": "pfy_live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
"created_at": "2026-03-16T12:00:00Z"
}⚠️
The key field is only returned once at creation time. Store it securely — it cannot be retrieved again. If you lose the key, you will need to delete it and create a new one.
Response Fields
| Field | Type | Description |
|---|---|---|
id | string (UUID) | Unique identifier for the API key. |
name | string | The descriptive name assigned to the key. |
scopes | array of strings | List of permission scopes granted to this key. |
key | string | The API key value. Only returned at creation time. |
created_at | string (ISO 8601) | Timestamp when the key was created. |
Errors
| Status | Description |
|---|---|
400 | Invalid request body (missing name or scopes). |
401 | Missing or invalid API key. |
403 | API key does not have api_keys:write scope. |
Code Examples
curl -X POST https://api.parsifyhq.com/api/v1/api-keys/ \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Production Integration",
"scopes": ["documents:read", "documents:write", "jobs:read"]
}'