POST/api/v1/playbooks/{id}/test

Test-run a playbook

Executes a playbook in dry-run mode — runs steps without committing side effects. Used to validate before activation.

Authentication

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

Response

200 example

{
  "success": true
}

All status codes

200Test result.
400(no description)
401(no description)
404(no description)
429(no description)

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/playbooks/{id}/test \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \

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/playbooks/{id}/test",
});
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/playbooks/{id}/test")
print(response)

Go

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/evalguard/evalguard-go"
)

func main() {
	client := evalguard.NewClient(os.Getenv("EVALGUARD_API_KEY"))
	resp, err := client.Request(context.Background(), "POST", "/api/v1/playbooks/{id}/test", nil)
	if err != nil { panic(err) }
	fmt.Println(resp)
}

Errors

400401404429

Other Compliance endpoints