Create api key

POST

https://api.schematichq.com/api-keys

POST

/api-keys

1 import { SchematicClient } from "@schematichq/schematic-typescript-node";
2 
3 async function main() {
4     const client = new SchematicClient({
5         apiKey: "YOUR_API_KEY_HERE",
6     });
7     await client.accounts.createApiKey({
8         name: "Project API Key",
9     });
10 }
11 main();

1 {
2   "data": {
3     "created_at": "2024-01-15T09:30:00Z",
4     "id": "api_key_abcdef1234567890",
5     "name": "Project API Key",
6     "readonly": true,
7     "scopes": [
8       "admin"
9     ],
10     "secret": "sk_live_51H8xY2eZbN7Q",
11     "updated_at": "2024-01-15T09:30:00Z",
12     "description": "Key for accessing project resources",
13     "environment": {
14       "created_at": "2024-01-10T08:00:00Z",
15       "environment_type": "development",
16       "id": "env_1234567890abcdef",
17       "name": "Development Environment",
18       "updated_at": "2024-01-15T09:00:00Z"
19     },
20     "environment_id": "env_1234567890abcdef",
21     "integration": {
22       "id": "int_9876543210fedcba",
23       "state": "active",
24       "type": "clerk"
25     },
26     "last_used_at": "2024-01-15T09:25:00Z",
27     "rate_limit_percent": 10
28   },
29   "params": {}
30 }

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Request

This endpoint expects an object.

namestringRequired1-256 characters

descriptionstring or nullOptional<=256 characters

environment_idstring or nullOptional

rate_limit_percentlong or nullOptional0-99

readonlyboolean or nullOptional

Response

Created

dataobject

paramsobject

Input parameters

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error