> ## Documentation Index > Fetch the complete documentation index at: https://docs.trybloom.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get a brand > Get a brand by ID. When `status` is `ready`, the brand can generate images. If `status` is `logo_required`, provide a logo with `PUT /brands/{id}/logo`. A brand with `status` `failed` includes failure details safe to show to users. Use `wait=true` to hold the connection until the status is `ready`, `logo_required`, or `failed`. If the request times out, it returns the current brand with `status` `analyzing`. ## OpenAPI ````yaml https://www.trybloom.ai/api/v1/spec.json get /brands/{id} openapi: 3.1.1 info: title: Bloom API version: 1.0.0 servers: - url: https://www.trybloom.ai/api/v1 security: - apiKey: [] - bearer: [] tags: - name: Account description: >- Inspect the authenticated account — profile, credit balance, and accessible workspaces. - name: Brands description: Manage brands and brand identity. - name: Images description: Generate, edit, and retrieve images. paths: /brands/{id}: get: tags: - Brands summary: Get a brand description: >- Get a brand by ID. When `status` is `ready`, the brand can generate images. If `status` is `logo_required`, provide a logo with `PUT /brands/{id}/logo`. A brand with `status` `failed` includes failure details safe to show to users. Use `wait=true` to hold the connection until the status is `ready`, `logo_required`, or `failed`. If the request times out, it returns the current brand with `status` `analyzing`. operationId: brands.get parameters: - name: id in: path required: true schema: type: string format: uuid description: Brand ID - name: wait in: query schema: anyOf: - type: boolean - enum: - '0' - '1' - 'true' - 'false' type: string default: false description: Hold the connection until the resource reaches a terminal status allowEmptyValue: true allowReserved: true - name: timeout in: query schema: type: integer minimum: 1 maximum: 295 default: 120 description: Max seconds to wait (default 120, max 295) allowEmptyValue: true allowReserved: true responses: '200': description: OK content: application/json: schema: type: object properties: data: type: object properties: id: type: string format: uuid status: enum: - analyzing - ready - logo_required - failed type: string failure: anyOf: - type: object properties: code: enum: - INVALID_URL - UNSUPPORTED_SOURCE - SCRAPE_FAILED - WEBSITE_SOURCE_REJECTED - INSTAGRAM_FETCH_FAILED - INSTAGRAM_PROFILE_NOT_FOUND - INSTAGRAM_PRIVATE_PROFILE - PDF_PROCESSING_FAILED - PDF_SOURCE_REJECTED - SOURCE_REJECTED - TARGET_RESTRICTED - BRAND_GUIDE_BUILD_FAILED - INTERNAL_ERROR - VISUAL_DNA_FAILED type: string message: type: string required: - code - message - type: 'null' profile: anyOf: - type: object properties: name: anyOf: - type: string - type: 'null' primaryLogo: anyOf: - type: object properties: url: type: string format: uri mediaType: anyOf: - type: string - type: 'null' required: - url - mediaType - type: 'null' favicon: anyOf: - type: object properties: url: type: string format: uri mediaType: anyOf: - type: string - type: 'null' required: - url - mediaType - type: 'null' palette: type: array items: type: object properties: hex: type: string name: anyOf: - type: string - type: 'null' required: - hex - name typography: anyOf: - type: object properties: heading: anyOf: - type: object properties: family: type: string required: - family - type: 'null' body: anyOf: - type: object properties: family: type: string required: - family - type: 'null' required: - heading - body - type: 'null' required: - name - primaryLogo - favicon - palette - typography - type: 'null' description: >- Current brand identity. Brands with an active Skill read this from that immutable Skill; brands still being created may not have a profile yet. activeSkill: anyOf: - type: object properties: id: type: string format: uuid createdAt: type: string format: date-time x-native-type: date required: - id - createdAt - type: 'null' description: Current immutable Brand Skill, when one is active. workspaceId: anyOf: - type: string - type: 'null' workspaceName: type: string createdAt: type: string format: date-time x-native-type: date required: - id - status - failure - profile - activeSkill - workspaceId - workspaceName - createdAt required: - data '401': description: '401' content: application/json: schema: $ref: '#/components/schemas/BrandsGet401ErrorResponse' '403': description: '403' content: application/json: schema: $ref: '#/components/schemas/BrandsGet403ErrorResponse' '404': description: '404' content: application/json: schema: $ref: '#/components/schemas/BrandsGet404ErrorResponse' '429': description: '429' content: application/json: schema: $ref: '#/components/schemas/BrandsGet429ErrorResponse' headers: Retry-After: description: >- Seconds until the API-key request limit resets. Present only when the request-rate limiter can calculate the delay. schema: type: integer minimum: 0 components: schemas: BrandsGet401ErrorResponse: type: object properties: error: allOf: - $ref: '#/components/schemas/ApiError' - anyOf: - type: object properties: code: const: UNAUTHORIZED status: const: 401 message: type: string default: Invalid or missing API credentials data: {} required: - code - status - message - type: object properties: code: type: string status: type: integer message: type: string data: {} required: - code - status - message required: - error BrandsGet403ErrorResponse: type: object properties: error: allOf: - $ref: '#/components/schemas/ApiError' - anyOf: - type: object properties: code: const: ACCOUNT_BANNED status: const: 403 message: type: string default: This account has been suspended. data: {} required: - code - status - message - type: object properties: code: const: FORBIDDEN status: const: 403 message: type: string default: Plan upgrade required data: {} required: - code - status - message - type: object properties: code: type: string status: type: integer message: type: string data: {} required: - code - status - message required: - error BrandsGet404ErrorResponse: type: object properties: error: allOf: - $ref: '#/components/schemas/ApiError' - anyOf: - type: object properties: code: const: BRAND_NOT_FOUND status: const: 404 message: type: string default: Brand not found data: {} required: - code - status - message - type: object properties: code: type: string status: type: integer message: type: string data: {} required: - code - status - message required: - error BrandsGet429ErrorResponse: type: object properties: error: allOf: - $ref: '#/components/schemas/ApiError' - anyOf: - type: object properties: code: const: TOO_MANY_REQUESTS status: const: 429 message: type: string default: Rate limit exceeded data: {} required: - code - status - message - type: object properties: code: type: string status: type: integer message: type: string data: {} required: - code - status - message required: - error ApiError: type: object properties: code: type: string status: type: integer message: type: string data: {} required: - code - status - message securitySchemes: apiKey: type: apiKey in: header name: x-api-key description: 'Bloom API key, for example `x-api-key: bloom_sk_...`.' bearer: type: http scheme: bearer description: Bloom API key (`Bearer bloom_sk_...`) or Bloom OAuth access token. ````