Summarize the reviews of a nomination

POST/v1/organization/{orgId}/awards/workspace/programs/{programId}/nominations/{submissionId}/review-summary

US Region: https://public-api.sessionboard.com · EU Region: https://public-api-eu.sessionboard.com

What the reviewers wrote about one nomination, summarized by Ask: summary (two or three sentences) and up to six points, each naming the reviewers who made it, plus reviewers with every comment as written. Only the written comments are summarized; scores are never sent to the model or changed. Reviewers who abstained are left out. Each call runs the model, so it is a POST, but it only reads. With AI turned off for the organization, or when the model is unavailable, summary is null, reason is unavailable and the comments still come back; with no comments yet, reason is no_comments. Requires read:awards; the token's user must manage the program. Refused for a key restricted to particular events. Also at POST /v1/awards/workspace/programs/{programId}/nominations/{submissionId}/review-summary.

Request example

cURL

curl --request POST \
  --url 'https://public-api.sessionboard.com/v1/organization/{orgId}/awards/workspace/programs/{programId}/nominations/{submissionId}/review-summary' \
  --header 'x-access-token: <api-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "language": "<string>"
}'

JavaScript

const response = await fetch('https://public-api.sessionboard.com/v1/organization/{orgId}/awards/workspace/programs/{programId}/nominations/{submissionId}/review-summary', {
  method: 'POST',
  headers: {
    "x-access-token": "<api-token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "language": "<string>"
  }),
});

const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "POST",
    "https://public-api.sessionboard.com/v1/organization/{orgId}/awards/workspace/programs/{programId}/nominations/{submissionId}/review-summary",
    headers={
        "x-access-token": "<api-token>",
        "Content-Type": "application/json"
    },
    json={
        "language": "<string>"
    },
)

print(response.json())

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://public-api.sessionboard.com/v1/organization/{orgId}/awards/workspace/programs/{programId}/nominations/{submissionId}/review-summary",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_POSTFIELDS => '{
  "language": "<string>"
}',
    CURLOPT_HTTPHEADER => [
        "x-access-token: <api-token>",
        "Content-Type: application/json",
    ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

Go

package main

import (
  "fmt"
  "io"
  "net/http"
  "strings"
)

func main() {
  req, _ := http.NewRequest("POST", "https://public-api.sessionboard.com/v1/organization/{orgId}/awards/workspace/programs/{programId}/nominations/{submissionId}/review-summary", strings.NewReader(`{
  "language": "<string>"
}`))
  req.Header.Add("x-access-token", "<api-token>")
  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(string(body))
}

Java

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://public-api.sessionboard.com/v1/organization/{orgId}/awards/workspace/programs/{programId}/nominations/{submissionId}/review-summary"))
    .header("x-access-token", "<api-token>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"language\": \"<string>\"\n}"))
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

Try it

RegionUS Region — https://public-api.sessionboard.comEU Region — https://public-api-eu.sessionboard.com

Authorization

Send asAPI token (x-access-token)OAuth access token (Bearer)

Token

Your token stays in this page. It is sent only to the region above and is never saved; it is gone when you leave or reload the page.

Path parameters

orgId*

programId*

submissionId*

Body application/json

{ "language": "<string>" }

POST

Send request

Authorizations

• x-access-tokenstringheader

  Organization API token. Generate from Organization Settings → API Tokens.

• AuthorizationBearer <token>headeror

  OAuth 2.1 access token. Obtained via the OAuth PKCE flow at /oauth/token.

Send one of these. See Authentication.

Path parameters

• orgIdstringpathrequired

  Your organization ID. Any other organization returns 404.

• programIdstring<uuid>pathrequired

  The Awards program ID.

• submissionIdstring<uuid>pathrequired

  The nomination's id.

Request body

application/json

• languagestring

  Language of the summary (en, fr, es, de). Defaults to the token user's language.

  Max length

  20

Example

{
  "language": "<string>"
}

Responses

200application/json

The summary and every reviewer's comments

• summarystring | null
• pointsobject[]
  Show child attributes

  • textstring
  • reviewersobject[]
    Show child attributes

    • refinteger
    • namestring
• reviewersobject[]
  Show child attributes

  • refinteger
  • namestring
  • commentsobject[]
    Show child attributes

    • roundstring | null
    • questionstring
    • textstring
• reasonstring | null

  Allowed values

  "no_comments", "unavailable", null

400application/json

VALIDATION_ERROR: the body or a path id does not match the schema. Unknown body fields are refused and named in the message; source is always accepted.

Error body for the Awards workspace operations.

• errorstringrequired

  Allowed values

  "VALIDATION_ERROR", "SCOPE_REQUIRED", "ORG_WIDE_TOKEN_REQUIRED", "FORBIDDEN", "NOT_FOUND", "CONFLICT", "QUOTA_EXCEEDED"

• messagestringrequired
• codestring

  A more specific reason, when there is one (trial_ended, plan_ended).

401

Missing, invalid or expired token.

403application/json

• SCOPE_REQUIRED: the token lacks read:awards. A write scope does not grant reads; a legacy token with no scopes may read.
• ORG_WIDE_TOKEN_REQUIRED: the key is restricted to particular events. The Awards workspace covers every awards program in the organization, so use a key without an event restriction.
• FORBIDDEN: the token's user is not an active member of the organization, lacks the Awards read permission, or does not manage the program.

Error body for the Awards workspace operations.

• errorstringrequired

  Allowed values

  "VALIDATION_ERROR", "SCOPE_REQUIRED", "ORG_WIDE_TOKEN_REQUIRED", "FORBIDDEN", "NOT_FOUND", "CONFLICT", "QUOTA_EXCEEDED"

• messagestringrequired
• codestring

  A more specific reason, when there is one (trial_ended, plan_ended).

404application/json

NOT_FOUND: orgId is not the token's organization, or the program is not in it.

Error body for the Awards workspace operations.

• errorstringrequired

  Allowed values

  "VALIDATION_ERROR", "SCOPE_REQUIRED", "ORG_WIDE_TOKEN_REQUIRED", "FORBIDDEN", "NOT_FOUND", "CONFLICT", "QUOTA_EXCEEDED"

• messagestringrequired
• codestring

  A more specific reason, when there is one (trial_ended, plan_ended).

429application/json

• The token's request limit (100 requests per 15 minutes by default, per bucket). Wait Retry-After seconds. The body is the TooManyRequestsError shape — see Rate Limiting.
• Writes only: QUOTA_EXCEEDED, the token's daily write quota (10,000 writes a day). It resets at midnight UTC.

• responseTooManyRequestsError | AwardsWorkspaceError
  name: TooManyRequestsError (TooManyRequestsError)

  Body of a 429 from the API's own request limits (per token, and per organization and user). Wait Retry-After seconds.

  • statusinteger

    Example

    429

  • successboolean

    Example

    false

  • messagestringrequired

    Example

    "Error while trying to reach the endpoint: Too many requests"

  • namestringrequired

    Allowed values

    "TooManyRequestsError"

  Option 2 (AwardsWorkspaceError)

  Error body for the Awards workspace operations.

  • errorstringrequired

    Allowed values

    "VALIDATION_ERROR", "SCOPE_REQUIRED", "ORG_WIDE_TOKEN_REQUIRED", "FORBIDDEN", "NOT_FOUND", "CONFLICT", "QUOTA_EXCEEDED"

  • messagestringrequired
  • codestring

    A more specific reason, when there is one (trial_ended, plan_ended).

• Retry-Afterintegerheader

  Seconds to wait before retrying.

Response examples

200

{
  "summary": "<string>",
  "points": [
    {
      "text": "<string>",
      "reviewers": [
        {
          "ref": 123,
          "name": "<string>"
        }
      ]
    }
  ],
  "reviewers": [
    {
      "ref": 123,
      "name": "<string>",
      "comments": [
        {
          "round": "<string>",
          "question": "<string>",
          "text": "<string>"
        }
      ]
    }
  ],
  "reason": "no_comments"
}

400

{
  "error": "VALIDATION_ERROR",
  "message": "Error on body parameter: data should NOT have additional properties: \"winners\""
}

403 · Token lacks the read scope

{
  "error": "SCOPE_REQUIRED",
  "message": "Token missing required scope: read:awards"
}

403 · Key restricted to particular events

{
  "error": "ORG_WIDE_TOKEN_REQUIRED",
  "message": "The Awards workspace covers every awards program in the organization, so this API key (restricted to particular events) cannot use it. Use a key without an event restriction."
}

404

{
  "error": "NOT_FOUND",
  "message": "Awards Program could not be found"
}

429

{
  "status": 429,
  "success": false,
  "message": "Error while trying to reach the endpoint: Too many requests",
  "name": "TooManyRequestsError"
}