Skip to content
POST/api/v1/integrations/github

Configure GitHub integration

Stateless GitHub CI helper — it stores nothing and connects nothing; there is no OAuth, PKCE, or token vault on this path. Body requires `action`, one of two values. `generate-workflow` (with `evalConfigPath`, optional `schedule`) returns `{workflow, filename:'.github/workflows/evalguard.yml'}`, a ready-to-commit GitHub Actions YAML. `report-result` (with `result`, optional `threshold` 0..1 and `outputFormat` summary|annotations|both) formats an eval result into GitHub Actions job-summary / annotation output. Any other action returns 400.

Authentication

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

Request body required

Example

{
  "action": "string",
  "evalConfigPath": "string",
  "schedule": "string",
  "threshold": 0,
  "outputFormat": "summary"
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "action": {
          "type": "string",
          "maxLength": 100
        },
        "evalConfigPath": {
          "type": "string",
          "maxLength": 500
        },
        "schedule": {
          "type": "string",
          "maxLength": 200
        },
        "result": {},
        "threshold": {
          "type": "number"
        },
        "outputFormat": {
          "type": "string",
          "enum": [
            "summary",
            "annotations",
            "both"
          ]
        }
      },
      "required": [
        "action"
      ],
      "additionalProperties": {}
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200Configured.
400(no description)
401(no description)
403Forbidden — insufficient role for this operation.
429(no description)
500Internal Server Error — FORMAT_ERROR, WORKFLOW_ERROR.

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/integrations/github \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "action": "string", "evalConfigPath": "string", "schedule": "string", "threshold": 0, "outputFormat": "summary" }'

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/integrations/github", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "action": "string",
    "evalConfigPath": "string",
    "schedule": "string",
    "threshold": 0,
    "outputFormat": "summary"
  }),
});
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/integrations/github",
    headers=headers,
    json={
    "action": "string",
    "evalConfigPath": "string",
    "schedule": "string",
    "threshold": 0,
    "outputFormat": "summary"
},
)
print(response.status_code, response.json())

Go

package main

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

func main() {
	body := strings.NewReader(`{"action":"string","evalConfigPath":"string","schedule":"string","threshold":0,"outputFormat":"summary"}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/integrations/github", 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

400401403429500

Other Integrations endpoints