RArainbrand
Reviews

Request a Review

Check an asset against a brand's guidance. Retrieve the findings with Get a Review.

post/reviews

Request

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

Headers

idempotency-keystring

Optional key for safely retrying this request. Reuse it only with the same body.

Request body

brandSessionIdstring uuid required

Brand to review against.

checksstring[] required

Choose which checks to run: color, typography, logo, or copy, without duplicates. Completed outcomes are returned under results.

Example request

{
  "brandSessionId": "e6220a5e-4a68-4d39-8bb9-5105e9a3a164",
  "assets": [
    {
      "imageId": "b73f2048-38a5-4ea7-a6f7-5e1b4d06d990"
    }
  ],
  "checks": [
    "color",
    "copy"
  ],
  "context": {
    "notes": "Acme Inc. Atlas Pro launch image. Expected headline: \"Meet Atlas Pro\". Expected call to action: \"Explore Atlas Pro\"."
  }
}

Response

OK

Changes

No recorded changes to this operation across all 2 revisions of this API.