Skip to content
POST/api/v1/incidents

Create an AI incident

Creates an ai_incidents row. camelCase body: projectId+title+category required (category from a fixed enum). Returns 201.

Authentication

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

Request body required

Example

{
  "projectId": "string",
  "title": "string",
  "category": "string",
  "description": "string",
  "severity": "<Defaults to medium.>",
  "modelId": "string",
  "assignedTo": "string",
  "affectedUsers": 0,
  "metadata": {}
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "projectId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "title": {
          "type": "string",
          "minLength": 1,
          "maxLength": 500
        },
        "category": {
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "description": {
          "type": "string",
          "maxLength": 20000
        },
        "severity": {
          "type": "string",
          "maxLength": 50,
          "description": "Defaults to medium."
        },
        "modelId": {
          "type": "string",
          "maxLength": 200
        },
        "assignedTo": {
          "type": "string",
          "maxLength": 200
        },
        "affectedUsers": {
          "type": "number"
        },
        "metadata": {
          "type": "object",
          "additionalProperties": {}
        }
      },
      "required": [
        "projectId",
        "title",
        "category"
      ],
      "additionalProperties": {}
    }
  }
}

Response

201 example

{
  "success": true
}

All status codes

201Created.
400(no description)
401(no description)
403Forbidden - insufficient role for this operation.
429(no description)

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/incidents \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "projectId": "string", "title": "string", "category": "string", "description": "string", "severity": "<Defaults to medium.>", "modelId": "string", "assignedTo": "string", "affectedUsers": 0, "metadata": {} }'

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/incidents",
  body: {
    "projectId": "string",
    "title": "string",
    "category": "string",
    "description": "string",
    "severity": "<Defaults to medium.>",
    "modelId": "string",
    "assignedTo": "string",
    "affectedUsers": 0,
    "metadata": {}
  },
});
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/incidents",
    body={
    "projectId": "string",
    "title": "string",
    "category": "string",
    "description": "string",
    "severity": "<Defaults to medium.>",
    "modelId": "string",
    "assignedTo": "string",
    "affectedUsers": 0,
    "metadata": {}
},
)
print(response)

Go

package main

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

func main() {
	body := strings.NewReader(`{"projectId":"string","title":"string","category":"string","description":"string","severity":"<Defaults to medium.>","modelId":"string","assignedTo":"string","affectedUsers":0,"metadata":{}}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/incidents", 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 Monitoring endpoints