Skip to content
POST/api/v1/support

Create a support ticket

Submits a support request. type, subject, description required; priority optional (auto-derived for security/bug if omitted). pageUrl and metadata optional.

Authentication

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

Request body required

Example

{
  "type": "bug",
  "subject": "string",
  "description": "string",
  "priority": "low",
  "pageUrl": "string",
  "metadata": {}
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "required": [
        "type",
        "subject",
        "description"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "bug",
            "feedback",
            "feature_request",
            "support",
            "security"
          ]
        },
        "subject": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "description": {
          "type": "string",
          "minLength": 1,
          "maxLength": 5000
        },
        "priority": {
          "type": "string",
          "enum": [
            "low",
            "medium",
            "high",
            "critical"
          ]
        },
        "pageUrl": {
          "type": "string"
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    }
  }
}

Response

201 example

{
  "success": true
}

All status codes

201Ticket created.
400(no description)
401(no description)
403Forbidden — the credential is valid but lacks the API-key scope, member role, or plan entitlement this operation requires.
409Conflict — CONFLICT.
429(no description)
500Internal Server Error — DB_ERROR.

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/support \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "type": "bug", "subject": "string", "description": "string", "priority": "low", "pageUrl": "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/support", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "type": "bug",
    "subject": "string",
    "description": "string",
    "priority": "low",
    "pageUrl": "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/support",
    headers=headers,
    json={
    "type": "bug",
    "subject": "string",
    "description": "string",
    "priority": "low",
    "pageUrl": "string",
    "metadata": {}
},
)
print(response.status_code, response.json())

Go

package main

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

func main() {
	body := strings.NewReader(`{"type":"bug","subject":"string","description":"string","priority":"low","pageUrl":"string","metadata":{}}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/support", 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

400401403409429500

Other Admin endpoints