---
title: "Request a Review"
method: POST
path: "/reviews"
tags: ["Reviews"]
---

# Request a Review

`POST /reviews`

## Request

- Base URL: `https://www.rainbrand.com/api/v1`
- URL: `https://www.rainbrand.com/api/v1/reviews`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://www.rainbrand.com/api/auth/oauth2/authorize`
    - Token URL: `https://www.rainbrand.com/api/auth/oauth2/token`

Check an asset against a brand's guidance. Retrieve the findings with [Get a Review](/api-reference/reviews/get-a-review).

## Headers

- `idempotency-key` string: Optional key for safely retrying this request. Reuse it only with the same body.

## Request body

- object
  - `brandSessionId` string, uuid, required: Brand to review against.
  - `assets` union[], required: Image to review. Supported formats: PNG, JPEG, WebP, GIF, and SVG.
    - union
      - object
        - `url` string, uri, required: Public HTTPS URL of the image. Downloaded when the Review is created.
        - `filename` string: Filename for the linked image. Derived from the URL when omitted.
      - object
        - `uploadId` string, uuid, required: ID of a completed temporary upload from POST /uploads.
      - object
        - `imageId` string, uuid, required: ID of a completed image in the same workspace.
  - `checks` string[], required: Choose which checks to run: color, typography, logo, or copy, without duplicates. Completed outcomes are returned under results.
  - `context` object: Additional guidance or supporting images for the Review.
    - `notes` string: What the image is for, exact expected text, or other review guidance.
    - `images` union[]: Supporting images to compare against, such as a logo or product photo.
      - union
        - object
          - `url` string, uri, required: Public HTTPS URL of the image. Downloaded when the Review is created.
          - `filename` string: Filename for the linked image. Derived from the URL when omitted.
        - object
          - `uploadId` string, uuid, required: ID of a completed temporary upload from POST /uploads.
        - object
          - `imageId` string, uuid, required: ID of a completed image in the same workspace.

## Response `202`

OK

- object
  - `data` object, required
    - `id` string, uuid, required: Review ID.
    - `status` 'pending' | 'processing' | 'completed' | 'failed', required

## Other responses

- `400`: 400
- `401`: 401
- `402`: 402
- `403`: 403
- `404`: 404
- `409`: 409
- `429`: 429
- `500`: 500

---

[API](https://skmtc.dev/rainbrand/apis/rainbrand-api.md) - [All operations](https://skmtc.dev/rainbrand/apis/rainbrand-api/llms.txt) - [OpenAPI document](https://skmtc.dev/rainbrand/apis/rainbrand-api/revisions/012b8e9da4df?raw)