API quickstart

This example adds Acme Inc. from its website, then requests brand guidance and assets for an Atlas Pro launch image. Use an API key stored as RAINBRAND_API_KEY in your environment. All requests use https://www.rainbrand.com/api/v1.

1. Add a brand

curl -X POST https://www.rainbrand.com/api/v1/brands \
  -H "x-api-key: $RAINBRAND_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sources": [{ "kind": "website", "url": "https://acme.com" }]
  }'

Replace the website with your own. Create a brand lists the supported source formats. The response identifies the new brand:

{
  "data": {
    "id": "e6220a5e-4a68-4d39-8bb9-5105e9a3a164",
    "status": "analyzing"
  }
}

Use your returned data.id in place of the example Brand ID below. If you already have a brand, find its ID with List brands and continue here.

2. Wait until the brand is ready

curl "https://www.rainbrand.com/api/v1/brands/e6220a5e-4a68-4d39-8bb9-5105e9a3a164?wait=true" \
  -H "x-api-key: $RAINBRAND_API_KEY"

If data.status is still analyzing, repeat the read. Continue when it is ready and data.activeSkill is present. If the status is failed, read data.failure for the cause before trying again. If an existing brand returns logo_required, complete its logo selection in Rainbrand before continuing.

3. Request a Brief

curl -X POST https://www.rainbrand.com/api/v1/briefs \
  -H "x-api-key: $RAINBRAND_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "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\"."
  }'

The response contains the Brief’s ID. Use your returned data.id in the next request.

4. Retrieve the guidance and assets

curl "https://www.rainbrand.com/api/v1/briefs/657bcf79-1f2f-47fa-90f8-9245142980ed?wait=true" \
  -H "x-api-key: $RAINBRAND_API_KEY"

Repeat the read while data.status is pending or processing. When it is completed, data.guidance contains the task’s brand guidance and data.assets contains the selected files. A failed Brief includes data.error with the reason and whether a new attempt may succeed.

Use the Brief

Use the completed Brief with your own agents, models, or renderer. To generate through the AI Gateway, get a model to check its input schema, then pass the Brief’s ID as briefId:

Start a generation

Send the model input with the completed Brief.

Getting started

Brands

Briefs

Generate

Reviews

Media

Account

Support

1. Add a brand

2. Wait until the brand is ready

3. Request a Brief

4. Retrieve the guidance and assets

Use the Brief

Start a generation

​1. Add a brand

​2. Wait until the brand is ready

​3. Request a Brief

​4. Retrieve the guidance and assets

​Use the Brief

Start a generation

1. Add a brand

2. Wait until the brand is ready

3. Request a Brief

4. Retrieve the guidance and assets

Use the Brief