Skip to content
PATCH/api/v1/projects/{id}

Update a project

Updates `name` (2-50 chars), `slug` (2-50, lowercase alphanumeric + hyphens) and/or `settings`. Only fields present in the body are changed; sending none returns 400 NO_FIELDS. A slug already used in the org returns 409 DUPLICATE_SLUG, and an unknown id 404 NOT_FOUND. Requires the ADMIN role of the project's org plus `projects:update` (editor holds `projects:[read]` only), and is audit-logged.

Authentication

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

Parameters

id in pathrequired

Project id.

string

Request body required

Example

{
  "name": "string",
  "slug": "string",
  "settings": {}
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 2,
          "maxLength": 50
        },
        "slug": {
          "type": "string",
          "minLength": 2,
          "maxLength": 50,
          "pattern": "^[a-z0-9-]+$"
        },
        "settings": {
          "type": "object",
          "additionalProperties": true
        }
      },
      "additionalProperties": false
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200The updated project.
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.
404Project not found.
409Slug already exists in this org.
429(no description)
500Internal Server Error — DB_ERROR.

Code samples

cURL

# {id} is shown with an EXAMPLE value — replace it with real values.
curl -X PATCH \
  https://evalguard.ai/api/v1/projects/00000000-0000-0000-0000-000000000000 \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "string", "slug": "string", "settings": {} }'

TypeScript

// The TypeScript SDK (@evalguard/sdk) exposes TYPED methods — runEval,
// getEval, runSecurityScan, checkFirewall, … — not a generic request().
// For an arbitrary endpoint, call it directly:
// {id} is shown with an EXAMPLE value — replace it with real values.

const res = await fetch("https://evalguard.ai/api/v1/projects/00000000-0000-0000-0000-000000000000", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "string",
    "slug": "string",
    "settings": {}
  }),
});
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:
# {id} is shown with an EXAMPLE value — replace it with real values.

import os
import requests

headers = {"Authorization": f"Bearer {os.environ['EVALGUARD_API_KEY']}"}
headers["Content-Type"] = "application/json"

response = requests.request(
    "PATCH",
    "https://evalguard.ai/api/v1/projects/00000000-0000-0000-0000-000000000000",
    headers=headers,
    json={
    "name": "string",
    "slug": "string",
    "settings": {}
},
)
print(response.status_code, response.json())

Go

package main

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

// {id} is shown with an EXAMPLE value — replace it with real values.
func main() {
	body := strings.NewReader(`{"name":"string","slug":"string","settings":{}}`)
	req, _ := http.NewRequestWithContext(context.Background(), "PATCH", "https://evalguard.ai/api/v1/projects/00000000-0000-0000-0000-000000000000", 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

400401403404409429500

Other Compliance endpoints