Flux AI AI Generations API

The AI Generations API from Flux AI — 5 operation(s) for ai generations.

GitHub OpenAPI

Operations 6

POST /api/v1/ai/generations Submit generation (generations:write) #
GET /api/v1/ai/generations List your tasks (generations:read) #
GET /api/v1/ai/generations/{taskId} Read your task (generations:read) #
GET /api/v1/ai/generations/{taskId}/events Read task events (generations:read) #
POST /api/v1/ai/generations/{taskId}/cancel cancel your task (generations:write) #
POST /api/v1/ai/generations/{taskId}/retry retry your task (generations:write) #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/fluxaipro-art:fluxaipro-art-ai-generations-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

fluxaipro-art-ai-generations-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Fluxaipro Art AI Generations API
  version: 1.1.0
  contact:
    name: Flux AI Support
    email: support@fluxaipro.art
    url: http://localhost:3001/contact
  description: 'Operations tagged AI Generations across 2 of this provider''s published API definitions: fluxaipro-art-openapi.json, fluxaipro-art-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: http://localhost:3001
  description: Flux AI production
security:
- bearerAuth: []
tags:
- name: AI Generations
paths:
  /api/v1/ai/generations:
    post:
      tags:
      - AI Generations
      operationId: createGenerationTask
      summary: Submit generation (generations:write)
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerationTaskCreateRequest'
      responses:
        '200':
          description: Task admitted; poll taskId for completion
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerationTaskCreateResponse'
        '400':
          description: Invalid request or insufficient credits (code 4407)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing, invalid, expired or revoked credential
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Insufficient permission
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Task not found or not owned by you
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit; retry with backoff
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Temporarily unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    get:
      tags:
      - AI Generations
      operationId: listGenerationTasks
      summary: List your tasks (generations:read)
      parameters:
      - name: page
        in: query
        schema:
          type: integer
          minimum: 1
          default: 1
      - name: pageSize
        in: query
        schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 20
      responses:
        '200':
          description: Task list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerationTaskList'
        '400':
          description: Invalid request or insufficient credits (code 4407)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing, invalid, expired or revoked credential
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Insufficient permission
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Task not found or not owned by you
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit; retry with backoff
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Temporarily unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    servers:
    - url: http://localhost:3001
      description: Flux AI production
  /api/v1/ai/generations/{taskId}:
    get:
      tags:
      - AI Generations
      operationId: getGenerationTask
      summary: Read your task (generations:read)
      parameters:
      - name: taskId
        in: path
        required: true
        schema:
          type: string
          pattern: ^[0-9]+$
      responses:
        '200':
          description: Task status and results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerationTask'
        '400':
          description: Invalid request or insufficient credits (code 4407)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing, invalid, expired or revoked credential
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Insufficient permission
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Task not found or not owned by you
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit; retry with backoff
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Temporarily unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    servers:
    - url: http://localhost:3001
      description: Flux AI production
  /api/v1/ai/generations/{taskId}/events:
    get:
      tags:
      - AI Generations
      operationId: getGenerationTaskEvents
      summary: Read task events (generations:read)
      parameters:
      - name: taskId
        in: path
        required: true
        schema:
          type: string
          pattern: ^[0-9]+$
      responses:
        '200':
          description: Events
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        '400':
          description: Invalid request or insufficient credits (code 4407)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing, invalid, expired or revoked credential
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Insufficient permission
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Task not found or not owned by you
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit; retry with backoff
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Temporarily unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    servers:
    - url: http://localhost:3001
      description: Flux AI production
  /api/v1/ai/generations/{taskId}/cancel:
    post:
      tags:
      - AI Generations
      operationId: cancelGenerationTask
      summary: cancel your task (generations:write)
      parameters:
      - name: taskId
        in: path
        required: true
        schema:
          type: string
          pattern: ^[0-9]+$
      responses:
        '200':
          description: Task action result
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '400':
          description: Invalid request or insufficient credits (code 4407)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing, invalid, expired or revoked credential
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Insufficient permission
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Task not found or not owned by you
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit; retry with backoff
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Temporarily unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    servers:
    - url: http://localhost:3001
      description: Flux AI production
  /api/v1/ai/generations/{taskId}/retry:
    post:
      tags:
      - AI Generations
      operationId: retryGenerationTask
      summary: retry your task (generations:write)
      parameters:
      - name: taskId
        in: path
        required: true
        schema:
          type: string
          pattern: ^[0-9]+$
      responses:
        '200':
          description: Task action result
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '400':
          description: Invalid request or insufficient credits (code 4407)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing, invalid, expired or revoked credential
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Insufficient permission
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Task not found or not owned by you
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit; retry with backoff
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Temporarily unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    servers:
    - url: http://localhost:3001
      description: Flux AI production
components:
  schemas:
    GenerationTaskCreateResponse:
      type: object
      required:
      - taskId
      - status
      - createdAt
      properties:
        taskId:
          type: string
        status:
          type: string
        invokeType:
          type: string
        createdAt:
          type: string
          format: date-time
        batchId:
          type: string
        tasks:
          type: array
          items:
            type: object
            properties:
              taskId:
                type: string
              status:
                type: string
              createdAt:
                type: string
                format: date-time
    GenerationTask:
      type: object
      required:
      - taskId
      - status
      additionalProperties: true
      properties:
        taskId:
          type: string
        status:
          type: string
        model:
          type: string
        modality:
          type: string
        displayName:
          type: string
        subType:
          type:
          - string
          - 'null'
        invokeType:
          type: string
        result: {}
        error: {}
        createdAt:
          type: string
          format: date-time
        startedAt:
          type:
          - string
          - 'null'
          format: date-time
        finishedAt:
          type:
          - string
          - 'null'
          format: date-time
    GenerationTaskList:
      type: object
      required:
      - list
      - total
      - page
      - pageSize
      properties:
        list:
          type: array
          items:
            type: object
            description: List rows use id as the task identifier.
            properties:
              id:
                type: string
              status:
                type: string
              model:
                type: string
              result: {}
              error: {}
            additionalProperties: true
        groups:
          type: array
          items:
            type: object
            additionalProperties: true
        total:
          type: integer
        page:
          type: integer
        pageSize:
          type: integer
        totalPages:
          type: integer
    ErrorResponse:
      type: object
      properties:
        code:
          type:
          - integer
          - string
        message:
          type: string
        data: {}
      additionalProperties: true
    GenerationTaskCreateRequest:
      type: object
      required:
      - modality
      - params
      properties:
        model:
          type: string
          description: Use the model identifier returned by GET /api/v1/ai/models.
        displayName:
          type: string
        modality:
          type: string
          enum:
          - image
          - video
          - audio
          - text
        subType:
          type: string
        params:
          type: object
          additionalProperties: true
          description: Parameters must satisfy the selected model's paramSchema.
        count:
          type: integer
          minimum: 1
          maximum: 4
          default: 1
          description: Image batch size; other modalities support one task.
        dedupeKey:
          type: string
          description: Reuse this for the same submission when retrying to avoid duplicate billing.
        priority:
          type: integer
          minimum: 1
          maximum: 10
          default: 5
        invokeType:
          type: string
          enum:
          - poll
          - await
          default: await
          description: Use poll for integrations. Both return task admission, not a finished media result. Poll GET /ai/generations/{taskId}.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Flux AI API key
      description: Create a key in Account settings > API keys (open from /developers). Read requires generations:read. Create, retry and cancel require generations:write. Keys access only their owner's tasks.
    mcpOAuth:
      type: http
      scheme: bearer
      bearerFormat: Clerk OAuth access token
      description: Discover OAuth at /.well-known/oauth-protected-resource/api/mcp. Existing Flux AI API keys are also accepted by MCP.
externalDocs:
  url: http://localhost:3001/developers
  description: Developer guide
x-refined-from:
- fluxaipro-art-openapi.json
- fluxaipro-art-openapi.yaml