Skip to content
POST/api/v1/api-keys

Create a new API key

Creates an API key for the org. The full key (rawKey) is returned ONLY on creation. scopes default to ['*'] (all-access) when omitted; an empty/omitted scope set records full access explicitly. Editor role required.

Authentication

Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/api-keys.

Request body required

Example

{
  "orgId": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "scopes": [],
  "expiresAt": "2026-07-14T19:53:34.694Z",
  "tpmLimit": 0,
  "rpmLimit": 0,
  "maxParallel": 0,
  "modelAllowlist": [
    "string"
  ]
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "orgId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "scopes": {
          "default": [],
          "maxItems": 50,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 100
          },
          "description": "Validated against the allowed noun:verb / verb:noun scope set plus '*'. 400 INVALID_SCOPES on unknown scope."
        },
        "expiresAt": {
          "nullable": true,
          "type": "string",
          "format": "date-time",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
        },
        "tpmLimit": {
          "nullable": true,
          "type": "integer",
          "minimum": 0,
          "exclusiveMinimum": true,
          "maximum": 10000000
        },
        "rpmLimit": {
          "nullable": true,
          "type": "integer",
          "minimum": 0,
          "exclusiveMinimum": true,
          "maximum": 10000000
        },
        "maxParallel": {
          "nullable": true,
          "type": "integer",
          "minimum": 0,
          "exclusiveMinimum": true,
          "maximum": 10000
        },
        "modelAllowlist": {
          "nullable": true,
          "maxItems": 100,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 200
          }
        }
      },
      "required": [
        "orgId",
        "name",
        "scopes"
      ],
      "additionalProperties": false
    }
  }
}

Response

201 example

{
  "success": true
}

All status codes

201API key created (includes rawKey).
400(no description)
401(no description)
403Forbidden — editor role required.
429(no description)

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/api-keys \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "orgId": "00000000-0000-0000-0000-000000000000", "name": "string", "scopes": [], "expiresAt": "2026-07-14T19:53:34.694Z", "tpmLimit": 0, "rpmLimit": 0, "maxParallel": 0, "modelAllowlist": [ "string" ] }'

TypeScript

import { EvalGuard } from "@evalguard/sdk";

const client = new EvalGuard({ apiKey: process.env.EVALGUARD_API_KEY });

const response = await client.request({
  method: "POST",
  path: "/api/v1/api-keys",
  body: {
    "orgId": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "scopes": [],
    "expiresAt": "2026-07-14T19:53:34.694Z",
    "tpmLimit": 0,
    "rpmLimit": 0,
    "maxParallel": 0,
    "modelAllowlist": [
      "string"
    ]
  },
});
console.log(response);

Python

from evalguard import EvalGuard
import os

client = EvalGuard(api_key=os.environ["EVALGUARD_API_KEY"])

response = client.request(
    method="POST",
    path="/api/v1/api-keys",
    body={
    "orgId": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "scopes": [],
    "expiresAt": "2026-07-14T19:53:34.694Z",
    "tpmLimit": 0,
    "rpmLimit": 0,
    "maxParallel": 0,
    "modelAllowlist": [
        "string"
    ]
},
)
print(response)

Go

package main

import (
	"context"
	"fmt"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{"orgId":"00000000-0000-0000-0000-000000000000","name":"string","scopes":[],"expiresAt":"2026-07-14T19:53:34.694Z","tpmLimit":0,"rpmLimit":0,"maxParallel":0,"modelAllowlist":["string"]}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/api-keys", body)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("EVALGUARD_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	fmt.Println(resp.Status)
}

Errors

400401403429

Other API Keys endpoints