Skip to content
POST/api/v1/users

Invite a user to the org

Records or updates a tracked END USER of a project (`tracked_users`) — SDK telemetry, not a team invitation. Body: { projectId, userId } required (`userId` is the customer's own external id), plus optional `name`, `email`, `metadata`. Upserts on conflict (project_id, external_id) and refreshes `last_seen`, so repeat calls update rather than duplicate; there is no `Idempotency-Key` support. Requires the TEAM plan, `member` role or above and `evals:create`, with project membership verified before the handler runs — the write uses a service-role client, so that gate is the only authorization. Audit-logged (`create` on `tracked_user`). Returns the stored row 201.

Authentication

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

Request body required

Example

{
  "email": "user@example.com",
  "role": "admin"
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "required": [
        "email",
        "role"
      ],
      "properties": {
        "email": {
          "type": "string",
          "format": "email"
        },
        "role": {
          "type": "string",
          "enum": [
            "admin",
            "member",
            "viewer"
          ]
        }
      }
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200Invitation sent.
201Created.
400(no description)
401(no description)
403Forbidden — insufficient role for this operation.
409Conflict — CONFLICT.
429(no description)
500Internal Server Error — DB_ERROR.

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/users \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "email": "user@example.com", "role": "admin" }'

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/users", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "email": "user@example.com",
    "role": "admin"
  }),
});
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/users",
    headers=headers,
    json={
    "email": "user@example.com",
    "role": "admin"
},
)
print(response.status_code, response.json())

Go

package main

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

func main() {
	body := strings.NewReader(`{"email":"user@example.com","role":"admin"}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/users", 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