RArainbrand
Briefs

Request a Brief

Prepare brand guidance and selected assets for a specific task. Retrieve the result with Get a Brief.

post/briefs

Request

  • Base URL
    https://www.rainbrand.com/api/v1
  • URL
    https://www.rainbrand.com/api/v1/briefs
  • 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 prepare the brief from.

taskstring required

What you are about to make, in plain language. Include any context or instructions that would help select the right brand guidance and files.

Example request

{
  "brandSessionId": "e6220a5e-4a68-4d39-8bb9-5105e9a3a164",
  "task": "A landscape launch image for Acme Inc. Atlas Pro. Center the product and include the headline \"Meet Atlas Pro\" and the call to action \"Explore Atlas Pro\"."
}

Response

OK

Changes

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