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

Add a comment or request a review on a prompt

`type:'review'` creates a review request for the given `reviewers[]` (name, version, reviewers required; max 50 reviewers); otherwise a comment is added (name, version, content required, optional `parentId` to thread it). The author / requestedBy identity is ALWAYS the authenticated caller's email — any `author` field in the body is ignored. Field caps: name 200 chars, content/message 20,000 chars (413 when exceeded). Requires the Pro plan and `prompts:create` (editor and above). Returns 201.

Authentication

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

Request body required

Schema
{
  "application/json": {
    "schema": {
      "oneOf": [
        {
          "type": "object",
          "required": [
            "type",
            "name",
            "version",
            "reviewers"
          ],
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "review"
              ]
            },
            "name": {
              "type": "string"
            },
            "version": {
              "type": "integer"
            },
            "reviewers": {
              "type": "array",
              "minItems": 1,
              "items": {
                "type": "string"
              }
            },
            "requestedBy": {
              "type": "string"
            }
          }
        },
        {
          "type": "object",
          "required": [
            "name",
            "version",
            "content"
          ],
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "comment"
              ],
              "description": "Default when omitted."
            },
            "name": {
              "type": "string"
            },
            "version": {
              "type": "integer"
            },
            "content": {
              "type": "string"
            },
            "author": {
              "type": "string"
            },
            "parentId": {
              "type": "string"
            }
          }
        }
      ],
      "discriminator": {
        "propertyName": "type"
      }
    }
  }
}

Response

201 example

{
  "success": true
}

All status codes

201Comment added or review requested.
400(no description)
401(no description)
403Forbidden — NO_EMAIL, NO_ORG, ORG_CONTEXT_REQUIRED.
413Payload Too Large.
429(no description)
500Internal Server Error — an unhandled error was converted to the standard error envelope (INTERNAL_ERROR).

Code samples

cURL

curl -X POST \
  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: "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/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(), "POST", "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

400401403413429500

Other Prompts endpoints