Skip to content
POST/api/v1/bulk

Run a bulk operation

Generic bulk dispatcher: body is { operations: [{ action, resource, id?, data? }] }, max 100 operations. action must be create | update | delete; resource must be eval_runs | datasets | security_scans | prompts. Each op is authorized independently — the target row's project→org is resolved and org membership checked, and for API-key callers the op's own scope (evals/datasets/security/prompts :write) must be held; per-field whitelists block mass assignment. Every op is reported in results[] with its original index and counted in succeeded/failed, so partial batches are visible; a write that matched zero rows is reported as a failure, not a success. Returns { results, succeeded, failed, total }.

Authentication

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

Request body required

Example

{
  "operations": [
    {
      "action": "string",
      "resource": "string",
      "id": "string",
      "data": {}
    }
  ]
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "operations": {
          "maxItems": 100,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "action": {
                "type": "string"
              },
              "resource": {
                "type": "string"
              },
              "id": {
                "type": "string",
                "maxLength": 200
              },
              "data": {
                "type": "object",
                "additionalProperties": {}
              }
            },
            "additionalProperties": false
          }
        }
      },
      "required": [
        "operations"
      ],
      "additionalProperties": false
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200Per-target results.
400(no description)
401(no description)
429(no description)
500Internal Server Error — an unhandled error was converted to the standard error envelope (INTERNAL_ERROR).

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/bulk \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "operations": [ { "action": "string", "resource": "string", "id": "string", "data": {} } ] }'

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/bulk", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "operations": [
      {
        "action": "string",
        "resource": "string",
        "id": "string",
        "data": {}
      }
    ]
  }),
});
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/bulk",
    headers=headers,
    json={
    "operations": [
        {
            "action": "string",
            "resource": "string",
            "id": "string",
            "data": {}
        }
    ]
},
)
print(response.status_code, response.json())

Go

package main

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

func main() {
	body := strings.NewReader(`{"operations":[{"action":"string","resource":"string","id":"string","data":{}}]}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/bulk", 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

400401429500

Other Evals endpoints