Skip to content
POST/api/v1/shares

Create a resource share

Action-discriminated. `action: "create"` mints an UNSIGNED 128-bit random `share_id` (`randomBytes(16)` hex) and inserts a `shared_traces` row for a trace, returning that row 201 — the caller composes the public URL from the id. Requires { traceId, projectId }; the trace must belong to that project (404 TRACE_NOT_FOUND) and membership of the project's org is verified before the handler runs. `expiresInHours` is optional (integer 1-8760); OMITTING it means the link NEVER expires. `action: "revoke"` sets `is_active: false` for a `shareId`; session callers may only revoke their own shares, an API-key caller may revoke any share in the key's verified org (the share's project is resolved through a service client so the membership gate always fires). There is no HMAC and no `timingSafeEqual` — the reader at GET /api/v1/shares matches the token by database equality and gates on `is_active`, expiry and a 5/min rate limit.

Authentication

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

Response

200 example

{
  "success": true
}

All status codes

200Share created.
201Created.
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.
404Not Found — TRACE_NOT_FOUND.
409Conflict — CONFLICT.
429(no description)
500Internal Server Error — DB_ERROR.

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/shares \
  -H "Authorization: Bearer $EVALGUARD_API_KEY"

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/shares", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}` },
});
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']}"}

response = requests.request("POST", "https://evalguard.ai/api/v1/shares", headers=headers)
print(response.status_code, response.json())

Go

package main

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

func main() {
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/shares", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("EVALGUARD_API_KEY"))
	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	fmt.Println(resp.Status)
}

Errors

400401403404409429500

Other Compliance endpoints