> ## 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 model

> Get a model's details and input schema using its creator and model name. Check the schema for required fields, accepted values, and limits before starting a generation.



## OpenAPI

````yaml https://www.trybloom.ai/api/v1/spec.json get /models/{creator}/{model}
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.
  - name: Models
    description: Find available models and check their inputs.
  - name: Generations
    description: Generate images, video, audio, and SVG, then retrieve the results.
  - name: Uploads
    description: >-
      Stage private local files for Brand sources, Library images, and other
      supported operations.
paths:
  /models/{creator}/{model}:
    get:
      tags:
        - Models
      summary: Get a model
      description: >-
        Get a model's details and input schema using its creator and model name.
        Check the schema for required fields, accepted values, and limits before
        starting a generation.
      operationId: models.get
      parameters:
        - name: creator
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            description: >-
              Creator portion of the model ID from GET /models. For
              quiverai/arrow-2, use quiverai.
        - name: model
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            description: >-
              Model portion of the model ID from GET /models. For
              quiverai/arrow-2, use arrow-2.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        description: >-
                          Exact model ID. Use this value when fetching model
                          details or starting a generation.
                      name:
                        type: string
                        description: Display name of the model.
                      type:
                        enum:
                          - image
                          - video
                          - audio
                          - svg
                        type: string
                        description: Type of file the model generates.
                      description:
                        type: string
                        description: Description of the model and its capabilities.
                      inputTypes:
                        type: array
                        items:
                          type: string
                        description: >-
                          Types of input the model accepts. Check inputSchema
                          for the fields to send.
                      inputSchema:
                        type: object
                        propertyNames:
                          type: string
                        additionalProperties: {}
                        description: >-
                          JSON Schema defining the model's input fields,
                          required values, and limits. Use it to prepare input
                          for POST /generations.
                    required:
                      - id
                      - name
                      - type
                      - description
                      - inputTypes
                      - inputSchema
                required:
                  - data
        '401':
          description: '401'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelsGet401ErrorResponse'
        '403':
          description: '403'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelsGet403ErrorResponse'
        '404':
          description: '404'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelsGet404ErrorResponse'
        '429':
          description: '429'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelsGet429ErrorResponse'
          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
        '503':
          description: '503'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelsGet503ErrorResponse'
components:
  schemas:
    ModelsGet401ErrorResponse:
      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
    ModelsGet403ErrorResponse:
      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
    ModelsGet404ErrorResponse:
      type: object
      properties:
        error:
          allOf:
            - $ref: '#/components/schemas/ApiError'
            - anyOf:
                - type: object
                  properties:
                    code:
                      const: MODEL_NOT_FOUND
                    status:
                      const: 404
                    message:
                      type: string
                      default: Generation model 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
    ModelsGet429ErrorResponse:
      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
    ModelsGet503ErrorResponse:
      type: object
      properties:
        error:
          allOf:
            - $ref: '#/components/schemas/ApiError'
            - anyOf:
                - type: object
                  properties:
                    code:
                      const: CATALOG_UNAVAILABLE
                    status:
                      const: 503
                    message:
                      type: string
                      default: Could not load generation models
                    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.

````