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

Get prompt comments or a reviewer's pending reviews

Pass reviewerId to get that reviewer's pending review requests; pass name (and optional version) to get a prompt's comments. At least one of name/reviewerId is required.

Authentication

Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/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)
429(no description)

Code samples

cURL

curl -X GET \
  https://evalguard.ai/api/v1/prompts/collaboration \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \

TypeScript

import { EvalGuard } from "@evalguard/sdk";

const client = new EvalGuard({ apiKey: process.env.EVALGUARD_API_KEY });

const response = await client.request({
  method: "GET",
  path: "/api/v1/prompts/collaboration",
});
console.log(response);

Python

from evalguard import EvalGuard
import os

client = EvalGuard(api_key=os.environ["EVALGUARD_API_KEY"])

response = client.request(method="GET", path="/api/v1/prompts/collaboration")
print(response)

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

400401429

Other Prompts endpoints