> ## Documentation Index
> Fetch the complete documentation index at: https://www.trybloom.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get an image

> Get an image by ID. Use this to poll for generation results. When status is "completed", imageUrl contains a short redirect URL (/img/{id}). Use wait=true to hold the connection until a terminal status is reached.



## OpenAPI

````yaml https://www.trybloom.ai/api/v1/spec.json get /images/{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:
  /images/{id}:
    get:
      tags:
        - Images
      summary: Get an image
      description: >-
        Get an image by ID. Use this to poll for generation results. When status
        is "completed", imageUrl contains a short redirect URL (/img/{id}). Use
        wait=true to hold the connection until a terminal status is reached.
      operationId: images.get
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            description: Image ID — works for generated, uploaded, and scraped images
        - name: wait
          in: query
          required: false
          schema:
            anyOf:
              - type: boolean
              - enum:
                  - '0'
                  - '1'
                  - 'true'
                  - 'false'
            default: false
            description: Hold the connection until the resource reaches a terminal status
          style: deepObject
          explode: true
          allowEmptyValue: true
          allowReserved: true
        - name: timeout
          in: query
          required: false
          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
                      source:
                        enum:
                          - generated
                          - uploaded
                          - scraped
                      status:
                        anyOf:
                          - enum:
                              - pending
                              - generating
                              - completed
                              - failed
                          - type: 'null'
                      prompt:
                        anyOf:
                          - type: string
                          - type: 'null'
                      description:
                        anyOf:
                          - type: string
                          - type: 'null'
                      imageUrl:
                        anyOf:
                          - type: string
                          - type: 'null'
                      aspectRatio:
                        anyOf:
                          - enum:
                              - '1:1'
                              - '2:3'
                              - '3:2'
                              - '3:4'
                              - '4:3'
                              - '4:5'
                              - '5:4'
                              - '9:16'
                              - '16:9'
                              - '21:9'
                          - type: 'null'
                      width:
                        anyOf:
                          - type: number
                          - type: 'null'
                      height:
                        anyOf:
                          - type: number
                          - type: 'null'
                      actionType:
                        anyOf:
                          - enum:
                              - generation
                              - edit
                              - resize
                              - variant
                              - recreate
                              - remove-background
                              - vectorize
                          - type: 'null'
                      variantGroupId:
                        anyOf:
                          - type: string
                            format: uuid
                          - type: 'null'
                      workspaceId:
                        anyOf:
                          - type: string
                          - type: 'null'
                      workspaceName:
                        type: string
                      createdAt:
                        type: string
                        format: date-time
                        x-native-type: date
                    required:
                      - id
                      - source
                      - status
                      - prompt
                      - description
                      - imageUrl
                      - aspectRatio
                      - width
                      - height
                      - actionType
                      - variantGroupId
                      - workspaceId
                      - workspaceName
                      - createdAt
                required:
                  - data
        '401':
          description: '401'
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      defined:
                        const: true
                      code:
                        const: UNAUTHORIZED
                      status:
                        const: 401
                      message:
                        type: string
                        default: Invalid or missing API credentials
                      data: {}
                    required:
                      - defined
                      - code
                      - status
                      - message
                  - type: object
                    properties:
                      defined:
                        const: false
                      code:
                        type: string
                      status:
                        type: number
                      message:
                        type: string
                      data: {}
                    required:
                      - defined
                      - code
                      - status
                      - message
        '403':
          description: '403'
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      defined:
                        const: true
                      code:
                        const: FORBIDDEN
                      status:
                        const: 403
                      message:
                        type: string
                        default: Plan upgrade required
                      data: {}
                    required:
                      - defined
                      - code
                      - status
                      - message
                  - type: object
                    properties:
                      defined:
                        const: false
                      code:
                        type: string
                      status:
                        type: number
                      message:
                        type: string
                      data: {}
                    required:
                      - defined
                      - code
                      - status
                      - message
        '404':
          description: '404'
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      defined:
                        const: true
                      code:
                        const: IMAGE_NOT_FOUND
                      status:
                        const: 404
                      message:
                        type: string
                        default: Image not found
                      data: {}
                    required:
                      - defined
                      - code
                      - status
                      - message
                  - type: object
                    properties:
                      defined:
                        const: false
                      code:
                        type: string
                      status:
                        type: number
                      message:
                        type: string
                      data: {}
                    required:
                      - defined
                      - code
                      - status
                      - message
        '429':
          description: '429'
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      defined:
                        const: true
                      code:
                        const: TOO_MANY_REQUESTS
                      status:
                        const: 429
                      message:
                        type: string
                        default: Rate limit exceeded
                      data: {}
                    required:
                      - defined
                      - code
                      - status
                      - message
                  - type: object
                    properties:
                      defined:
                        const: false
                      code:
                        type: string
                      status:
                        type: number
                      message:
                        type: string
                      data: {}
                    required:
                      - defined
                      - code
                      - status
                      - message
components:
  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.

````