Create api key | SchematicHQ

X-Schematic-Api-Keystring

API Key authentication via header

This endpoint expects an object.

namestringRequired1-256 characters

descriptionstring or nullOptional<=256 characters

environment_idstring or nullOptional

readonlyboolean or nullOptional

Created

dataobject

paramsobject

Input parameters

1	import { SchematicClient } from "@schematichq/schematic-typescript-node";
2
3	const client = new SchematicClient({ apiKey: "YOUR_API_KEY" });
4	await client.accounts.createApiKey({
5	name: "name"
6	});

1	{
2	"data": {
3	"created_at": "2024-04-20T14:45:00Z",
4	"id": "api_key_9876543210abcdef",
5	"name": "Project Analytics Key",
6	"readonly": false,
7	"scopes": [
8	"read",
9	"capture"
10	],
11	"secret": "sk_live_4f3b2a1c9d8e7f6a5b4c3d2e1f0a9b8c",
12	"updated_at": "2024-04-20T14:45:00Z",
13	"description": "API key for accessing project analytics data",
14	"environment_id": "env-prod-1234",
15	"last_used_at": "2024-04-25T10:15:00Z"
16	},
17	"params": {}
18	}