Create api key | SchematicHQ

import { SchematicClient } from "@schematichq/schematic-typescript-node";
async function main() {
    const client = new SchematicClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.accounts.createApiKey({
        name: "Production API Key",
    });
}
main();

{
  "data": {
    "created_at": "2024-04-10T14:22:35Z",
    "id": "key_1234567890abcdef",
    "name": "Production API Key",
    "readonly": false,
    "scopes": [
      "read",
      "write"
    ],
    "secret": "sk_live_4f3e2d1c0b9a8e7f6d5c4b3a2f1e0d9c",
    "updated_at": "2024-04-10T14:22:35Z",
    "description": "Key for production environment access",
    "environment_id": "env_9f8b7c6d5e4a3b2c1d0e",
    "last_used_at": "2024-04-15T08:45:12Z"
  },
  "params": {}
}

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

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