Skip to content
POST/api/v1/agent-runs/start

Start an agent execution meter

Opens an agent_runs row via the `agent_run_start` RPC (enforces run-count + monthly-spend caps). All body fields optional, but a JSON body is required — send `{}` at minimum. `apiKeyId` defaults to the authenticating key ONLY when the key is presented as `Authorization: Bearer eg_…`; callers using the `x-api-key` header must pass `apiKeyId` explicitly or get 400 MISSING_API_KEY_ID. When `apiKeyId` is supplied, the org that owns THAT key is the membership scope. 402 RUN_DENIED_* when a cap is already breached. Returns 201 with { runId, status, startedAt }.

Authentication

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

Request body required

Example

{
  "apiKeyId": "00000000-0000-0000-0000-000000000000",
  "endCustomerId": "string",
  "traceId": "string",
  "metadata": {}
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "apiKeyId": {
          "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)$",
          "description": "Key to meter against. Defaults to the eg_ key used for auth."
        },
        "endCustomerId": {
          "type": "string",
          "maxLength": 256
        },
        "traceId": {
          "type": "string",
          "maxLength": 256
        },
        "metadata": {
          "type": "object",
          "additionalProperties": {}
        }
      },
      "additionalProperties": false
    }
  }
}

Response

201 example

{
  "runId": "00000000-0000-0000-0000-000000000000",
  "status": "string",
  "startedAt": "2026-01-01T00:00:00.000Z"
}

All status codes

201Run started.
400(no description)
401(no description)
402Payment Required - run denied because a run-count or monthly-spend cap is already breached.
403Forbidden — the credential is valid but lacks the API-key scope, member role, or plan entitlement this operation requires.
429(no description)
500Internal Server Error — DB_EMPTY, DB_ERROR.
503Service Unavailable — AUTHZ_UNAVAILABLE.

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/agent-runs/start \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "apiKeyId": "00000000-0000-0000-0000-000000000000", "endCustomerId": "string", "traceId": "string", "metadata": {} }'

TypeScript

// The TypeScript SDK (@evalguard/sdk) exposes TYPED methods — runEval,
// getEval, runSecurityScan, checkFirewall, … — not a generic request().
// For an arbitrary endpoint, call it directly:

const res = await fetch("https://evalguard.ai/api/v1/agent-runs/start", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "apiKeyId": "00000000-0000-0000-0000-000000000000",
    "endCustomerId": "string",
    "traceId": "string",
    "metadata": {}
  }),
});
console.log(res.status, await res.json());

Python

# The Python SDK (pip install evalguardai) exposes TYPED methods on
# EvalGuardClient — run_eval, get_eval, … — not a generic request().
# For an arbitrary endpoint, call it directly:

import os
import requests

headers = {"Authorization": f"Bearer {os.environ['EVALGUARD_API_KEY']}"}
headers["Content-Type"] = "application/json"

response = requests.request(
    "POST",
    "https://evalguard.ai/api/v1/agent-runs/start",
    headers=headers,
    json={
    "apiKeyId": "00000000-0000-0000-0000-000000000000",
    "endCustomerId": "string",
    "traceId": "string",
    "metadata": {}
},
)
print(response.status_code, response.json())

Go

package main

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

func main() {
	body := strings.NewReader(`{"apiKeyId":"00000000-0000-0000-0000-000000000000","endCustomerId":"string","traceId":"string","metadata":{}}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/agent-runs/start", 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

400401402403429500503

Other Evals endpoints