Skip to content
GET/api/v1/prompts/collaboration

Get prompt comments or a reviewer's pending reviews

With `?name` (and optional `?version`) returns that prompt's comment thread for the caller's org; with no parameters returns the CALLER's own pending review requests. A `reviewerId` parameter is ignored — you can only ever see your own pending reviews. Requires an authenticated session with an org membership and the Pro plan. State is held per org in the app process and is not persisted across restarts.

Authentication

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

Parameters

name in query

Prompt name — returns its comments.

string
version in query

Scope comments to one version of the named prompt.

integer
reviewerId in query

Returns this reviewer's pending reviews.

string

Response

200 example

{
  "success": true
}

All status codes

200Comments array or pending reviews.
400(no description)
401(no description)
403Forbidden — NO_EMAIL, NO_ORG, ORG_CONTEXT_REQUIRED.
429(no description)
500Internal Server Error — COLLABORATION_ERROR.

Code samples

cURL

curl -X GET \
  https://evalguard.ai/api/v1/prompts/collaboration \
  -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/prompts/collaboration", {
  method: "GET",
  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("GET", "https://evalguard.ai/api/v1/prompts/collaboration", headers=headers)
print(response.status_code, response.json())

Go

package main

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

func main() {
	req, _ := http.NewRequestWithContext(context.Background(), "GET", "https://evalguard.ai/api/v1/prompts/collaboration", 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

400401403429500

Other Prompts endpoints