---
title: "Get a Brief"
method: GET
path: "/briefs/{id}"
tags: ["Briefs"]
---

# Get a Brief

`GET /briefs/{id}`

## Request

- Base URL: `https://www.rainbrand.com/api/v1`
- URL: `https://www.rainbrand.com/api/v1/briefs/{id}`
- 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`

Get a Brief's current status and, when complete, its Markdown guidance and selected assets.

## Path parameters

- `id` string, uuid, required: Brief ID.

## Query parameters

- `wait` union: Hold the connection until the resource reaches a terminal status
  - boolean
  - '0' | '1' | 'true' | 'false'
- `timeout` integer: Max seconds to wait (default 120, max 295)

## Response `200`

OK

- object
  - `data` object, required
    - `id` string, uuid, required: Brief ID.
    - `status` 'pending' | 'processing' | 'completed' | 'failed', required: Current status of the brief.
    - `skillId` string, uuid, nullable, required: Brand Skill version used to prepare the brief, or null if that version was deleted.
    - `createdAt` string, date-time, required: When the brief was requested.
    - `completedAt` string, date-time: When the brief completed.
    - `guidance` string: Brand guidance for the task, in Markdown. Available when completed.
    - `assets` object[]: Files selected for the task. Available when completed.
      - `kind` 'logo' | 'image' | 'font' | 'font_render', required: Asset type. A font render is an image preview of a font.
      - `mediaType` 'image/avif' | 'image/gif' | 'image/jpeg' | 'image/png' | 'image/svg+xml' | 'image/webp' | 'image/x-icon' | 'font/otf' | 'font/ttf' | 'font/woff' | 'font/woff2', required: MIME type of the image or font file.
      - `url` string, uri, required: Stable Rainbrand asset URL with no scheduled expiry. Redirects to fresh storage access while the completed brief, brand, saved Brand Skill version, and asset remain available. Anyone with this link can access the asset without signing in.
      - `mediaId` string, uuid: Media ID when the asset is a Library file. Absent for files that live inside the Brand Skill, such as fonts.
    - `error` object: Failure details. Available when the brief failed.
      - `code` string, required: Error code identifying the failure.
      - `message` string, required: Human-readable explanation of the failure.
      - `retryable` boolean, required: Whether you can retry by creating a new brief with a new idempotency key.
    - `failedAt` string, date-time: When the brief failed.

## Other responses

- `401`: 401
- `403`: 403
- `404`: 404
- `429`: 429

---

[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)