RArainbrand
Briefs

Get a Brief

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

get/briefs/{id}

Request

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

Path parameters

idstring uuid required

Brief ID.

Example:657bcf79-1f2f-47fa-90f8-9245142980ed

Query parameters

boolean
OR
'0' | '1' | 'true' | 'false'
timeoutinteger

Max seconds to wait (default 120, max 295)

Response

OK

Changes

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