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

# Get model

> Retrieve a single model by ID.



## OpenAPI

````yaml /api/openapi.public.json get /v1/models/{id}
openapi: 3.1.0
info:
  title: Runflow API
  version: 0.1.0
  description: >-
    Public Runflow API. Run AI image and video models, manage media, inspect run
    history, and configure webhooks. Auth: HTTP Bearer.


    This document is the customer integration surface only. Admin and internal
    operations plus generic system reference-data tables are intentionally
    omitted.
servers:
  - url: https://api.runflow.io
    description: Production
security:
  - HTTPBearer: []
tags:
  - name: Models
    description: >-
      Browse the model catalog and dispatch model runs. The primary surface for
      running AI image and video generation.
  - name: Runs
    description: >-
      Inspect, cancel, and re-run model executions. Fetch logs, node-runs, and
      callback delivery history.
  - name: Media
    description: >-
      Upload images and videos as inputs. Organize assets into folders.
      Three-step presigned upload flow for large files.
  - name: Batches
    description: >-
      Run a model on multiple inputs in one request. Includes per-item status
      and a single callback when the batch completes.
  - name: Evaluations
    description: >-
      Submit an image generated anywhere for automated quality evaluation, then
      read a pass verdict, a 0-1 score, and structured issues. No Runflow run
      required.
  - name: Webhooks
    description: >-
      Subscribe to platform events. Inspect delivery history, redeliver failed
      callbacks, manage signing secrets.
  - name: Account
    description: Read your account identity and credit balance.
  - name: Status
    description: Health and readiness probes for the API.
paths:
  /v1/models/{id}:
    get:
      tags:
        - Models
      summary: Get model
      description: Retrieve a single model by ID.
      operationId: getModel
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Id
        - name: embed
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Relation embedding. Available values: examples, faq_entries,
              inputs, outputs, pricing, related_links. Use a comma-separated
              list to request multiple embeds.
            title: Embed
          description: >-
            Relation embedding. Available values: examples, faq_entries, inputs,
            outputs, pricing, related_links. Use a comma-separated list to
            request multiple embeds.
          examples:
            single:
              summary: Single embed
              value: examples
            multiple:
              summary: Multiple embeds
              value: examples,faq_entries
        - name: X-Organization-Id
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Organization-Id
      responses:
        '200':
          description: The requested model.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models__model__Model__FullValidator'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: >-
            Forbidden — inspect response body `code` for the specific reason
            (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED,
            ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED,
            IMPERSONATION_READ_ONLY)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - HTTPBearer: []
components:
  schemas:
    models__model__Model__FullValidator:
      properties:
        id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Id
        org_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Org Id
        model_creator_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Model Creator Id
        slug:
          anyOf:
            - type: string
            - type: 'null'
          title: Slug
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        version:
          anyOf:
            - type: string
            - type: 'null'
          title: Version
        is_public:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Public
        is_open_source:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Open Source
        icon_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Icon Url
        cover_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Cover Url
        category_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Category Code
        status_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Status Code
        family_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Family Id
        family_variant_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Family Variant Code
        param_count:
          anyOf:
            - type: string
            - type: 'null'
          title: Param Count
        architecture:
          anyOf:
            - type: string
            - type: 'null'
          title: Architecture
        license_code:
          anyOf:
            - type: string
            - type: 'null'
          title: License Code
        max_resolution:
          anyOf:
            - type: string
            - type: 'null'
          title: Max Resolution
        lora_support:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Lora Support
        fine_tuning:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Fine Tuning
        supports_streaming:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Supports Streaming
        paper_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Paper Url
        github_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Github Url
        is_official:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Official
        availability_status:
          anyOf:
            - type: string
            - type: 'null'
          title: Availability Status
        seo:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Seo
        notable_features:
          anyOf:
            - items: {}
              type: array
            - type: 'null'
          title: Notable Features
        content:
          anyOf:
            - type: string
            - type: 'null'
          title: Content
        pricing_note:
          anyOf:
            - type: string
            - type: 'null'
          title: Pricing Note
        created_by:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Created By
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Created At
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updated At
        deleted_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Deleted At
        deleted_by:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Deleted By
        inputs:
          anyOf:
            - items:
                $ref: '#/components/schemas/models__model__ModelInput__FullValidator'
              type: array
            - type: 'null'
          title: Inputs
        outputs:
          anyOf:
            - items:
                $ref: '#/components/schemas/models__model__ModelOutput__FullValidator'
              type: array
            - type: 'null'
          title: Outputs
        examples:
          anyOf:
            - items:
                $ref: >-
                  #/components/schemas/models__model_content__ModelExample__FullValidator
              type: array
            - type: 'null'
          title: Examples
        faq_entries:
          anyOf:
            - items:
                $ref: >-
                  #/components/schemas/models__model_content__ModelFaqEntry__FullValidator
              type: array
            - type: 'null'
          title: Faq Entries
        pricing:
          anyOf:
            - items:
                $ref: >-
                  #/components/schemas/models__model_content__ModelCustomerPricing__FullValidator
              type: array
            - type: 'null'
          title: Pricing
        related_links:
          anyOf:
            - items:
                $ref: >-
                  #/components/schemas/models__model_content__ModelRelatedLink__FullValidator
              type: array
            - type: 'null'
          title: Related Links
      type: object
      title: FullValidator
      description: Response shape.
    ErrorResponse:
      properties:
        code:
          type: string
          title: Code
        message:
          type: string
          title: Message
        errors:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          title: Errors
      type: object
      required:
        - code
        - message
      title: ErrorResponse
      description: Standard error envelope — matches exception handler output.
    models__model__ModelInput__FullValidator:
      properties:
        id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Id
        model_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Model Id
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        display_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Display Name
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        variable_type_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Variable Type Code
        default_behavior_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Default Behavior Code
        validator_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Validator Code
        validator_attrs:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Validator Attrs
        is_required:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Required
        default_value:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Default Value
        sort_order:
          anyOf:
            - type: integer
            - type: 'null'
          title: Sort Order
        is_featured:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Featured
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Created At
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updated At
      type: object
      title: FullValidator
      description: Response shape.
    models__model__ModelOutput__FullValidator:
      properties:
        id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Id
        model_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Model Id
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        display_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Display Name
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        variable_type_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Variable Type Code
        validator_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Validator Code
        validator_attrs:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Validator Attrs
        sort_order:
          anyOf:
            - type: integer
            - type: 'null'
          title: Sort Order
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Created At
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updated At
      type: object
      title: FullValidator
      description: Response shape.
    models__model_content__ModelExample__FullValidator:
      properties:
        id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Id
        model_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Model Id
        title:
          anyOf:
            - type: string
            - type: 'null'
          title: Title
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        input:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Input
        output:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Output
        status_code:
          anyOf:
            - type: integer
            - type: 'null'
          title: Status Code
        cost:
          anyOf:
            - type: string
              pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
            - type: 'null'
          title: Cost
        start_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Start Type
        timing:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Timing
        duration_ms:
          anyOf:
            - type: integer
            - type: 'null'
          title: Duration Ms
        total_ms:
          anyOf:
            - type: integer
            - type: 'null'
          title: Total Ms
        thumbnail_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Thumbnail Url
        category_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Category Code
        is_featured:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Featured
        is_public:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Public
        sort_order:
          anyOf:
            - type: integer
            - type: 'null'
          title: Sort Order
        ran_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Ran At
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Created At
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updated At
      type: object
      title: FullValidator
      description: Response shape.
    models__model_content__ModelFaqEntry__FullValidator:
      properties:
        id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Id
        model_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Model Id
        question:
          anyOf:
            - type: string
            - type: 'null'
          title: Question
        answer:
          anyOf:
            - type: string
            - type: 'null'
          title: Answer
        sort_order:
          anyOf:
            - type: integer
            - type: 'null'
          title: Sort Order
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Created At
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updated At
      type: object
      title: FullValidator
      description: Response shape.
    models__model_content__ModelCustomerPricing__FullValidator:
      properties:
        id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Id
        model_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Model Id
        pricing_model_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Pricing Model Code
        rule_effect_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Rule Effect Code
        model_input_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Model Input Id
        match_value:
          anyOf:
            - {}
            - type: 'null'
          title: Match Value
        dimension_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Dimension Code
        min_value:
          anyOf:
            - type: string
              pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
            - type: 'null'
          title: Min Value
        max_value:
          anyOf:
            - type: string
              pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
            - type: 'null'
          title: Max Value
        price:
          anyOf:
            - type: string
              pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
            - type: 'null'
          title: Price
        currency_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Currency Code
        unit_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Unit Code
        multiplier_label:
          anyOf:
            - type: string
            - type: 'null'
          title: Multiplier Label
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        sort_order:
          anyOf:
            - type: integer
            - type: 'null'
          title: Sort Order
        disabled_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Disabled At
        measurement_source:
          anyOf:
            - type: string
            - type: 'null'
          title: Measurement Source
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Created At
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updated At
      type: object
      title: FullValidator
      description: Response shape.
    models__model_content__ModelRelatedLink__FullValidator:
      properties:
        id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Id
        model_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Model Id
        related_model_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Related Model Id
        sort_order:
          anyOf:
            - type: integer
            - type: 'null'
          title: Sort Order
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Created At
      type: object
      title: FullValidator
      description: Response shape.
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````