kreatorflow-ai Jobs API

openapi: 3.2.0
info:
  title: Kreatorflow Ai Jobs API
  version: '2026-06-10'
  contact:
    name: KreatorFlow
    url: https://kreatorflow.ai/developers
    email: harry@kreatorflow.ai
  termsOfService: https://kreatorflow.ai/terms
  description: 'Operations tagged Jobs across 2 of this provider''s published API definitions: developers.kreatorflow.ai-openapi.json, kreatorflow-ai-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://kreatorflow.ai
  description: Production
security:
- bearerAuth: []
- apiKeyHeader: []
tags:
- name: Jobs
paths:
  /v1/jobs/{job_id}:
    get:
      operationId: getJobsByJobId
      summary: Poll a job created by the same developer account
      description: 'Poll a job created by the same developer account. Required scope: jobs:read. Rate limit: 120 per 60 seconds per account.'
      tags:
      - Jobs
      x-required-scope: jobs:read
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                required:
                - success
                - data
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    type: object
                    required:
                    - job
                    properties:
                      job:
                        $ref: '#/components/schemas/Job'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
    servers:
    - url: https://kreatorflow.ai
      description: Production
  /v1/jobs/{job_id}/output:
    get:
      operationId: getJobsByJobIdOutput
      summary: Download a completed job's output (the providerOutputUrl) with your API key…
      description: 'Download a completed job''s output (the providerOutputUrl) with your API key; supports HTTP range requests for video. Required scope: jobs:read. Rate limit: 300 per 60 seconds per account.'
      tags:
      - Jobs
      x-required-scope: jobs:read
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The finished file (video, image or audio). Supports HTTP range requests for video.
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
    head:
      operationId: headJobsByJobIdOutputHead
      summary: Download a completed job's output (the providerOutputUrl) with your API key…
      description: 'Download a completed job''s output (the providerOutputUrl) with your API key; supports HTTP range requests for video. Required scope: jobs:read. Rate limit: 300 per 60 seconds per account.'
      tags:
      - Jobs
      x-required-scope: jobs:read
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Headers of the finished file (size, type, range support).
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    servers:
    - url: https://kreatorflow.ai
      description: Production
components:
  responses:
    RateLimited:
      description: Too many requests in the window.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      headers:
        Retry-After:
          schema:
            type: integer
          description: Seconds to wait.
    NotFound:
      description: 'Not found. job_not_found: No job with that id for this key''s account. character_not_found: The character id or slug doesn''t exist. upload_not_found: The upload_id doesn''t exist in this workspace. reference_upload_not_found: A reference upload_id doesn''t exist in this workspace. video_edit_source_not_found: The source_video_upload_id doesn''t exist. image_upload_not_found: The image_upload_id isn''t in this workspace. audio_upload_not_found: The audio_upload_id isn''t in this workspace (or audio_job_id isn''t a completed /v1/audio job).'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: 'Missing, wrong or revoked API key. invalid_api_key: The key is missing, wrong or revoked.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      headers:
        WWW-Authenticate:
          schema:
            type: string
          description: Bearer challenge (on /v1/mcp).
    Forbidden:
      description: 'Not allowed. account_not_active: The developer account is suspended. scope_missing: The key lacks the scope this endpoint needs. paid_account_required: Lip Sync needs a paid account. Nothing was charged.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Job:
      type: object
      properties:
        id:
          type: string
          description: string
        mediaType:
          type: string
          description: image, video, or audio
        modelId:
          type: string
          description: stable KreatorFlow model alias
        status:
          type: string
          description: created, queued, processing, completed, failed, canceled, or blocked
          enum:
          - created
          - queued
          - processing
          - completed
          - failed
          - canceled
          - blocked
        provider:
          type: string
          description: KreatorFlow routing label or null; upstream routing names are not exposed
        providerJobId:
          type: string
          description: always null in public API responses; poll by the KreatorFlow job id
        providerOutputId:
          type: string
          description: always null in public API responses
        providerOutputUrl:
          type: string
          description: KreatorFlow-authenticated output URL or null; fetch with your API key and store the output in your own storage
        providerOutputExpiresAt:
          type: string
          description: output URL expiry timestamp or null
        errorCode:
          type: string
          description: string or null
        errorMessage:
          type: string
          description: string or null
        resolution:
          type: string
          description: 'string optional; video jobs: the requested output resolution'
        warnings:
          type: array
          items:
            type: string
          description: array optional; includes video_reference_fallback_omitted_clips when a fallback output omitted video clip references
      additionalProperties: true
    Error:
      type: object
      required:
      - success
      - code
      - error
      properties:
        success:
          type: boolean
          const: false
        code:
          type: string
          description: Machine-readable error code.
          enum:
          - account_not_active
          - aspect_ratio_not_supported
          - audio_reference_too_long
          - audio_too_long
          - audio_too_short
          - audio_unreadable
          - audio_upload_not_found
          - character_not_found
          - character_pending
          - character_reference_limit_exceeded
          - character_reference_unusable
          - character_reference_upload_required
          - character_registration_failed
          - character_trusted_asset_failed
          - dispatch_disabled
          - duration_not_supported
          - face_consent_required
          - generation_dispatch_failed
          - generation_dispatch_missing
          - generation_failed
          - generation_output_missing
          - generation_poll_failed
          - generation_rejected
          - generation_timeout
          - generation_unavailable
          - image_rejected
          - image_upload_not_found
          - insufficient_balance
          - internal_error
          - invalid_api_key
          - job_not_found
          - model_not_found
          - paid_account_required
          - paid_check_unavailable
          - prompt_required
          - prompt_too_long
          - rate_limited
          - reference_asset_failed
          - reference_asset_pending
          - reference_combination_not_supported
          - reference_rejected
          - reference_upload_invalid
          - reference_upload_not_found
          - reference_upload_unusable
          - resolution_not_supported
          - response_format_not_supported
          - schema_missing
          - scope_missing
          - storage_not_configured
          - upload_id_invalid
          - upload_in_use
          - upload_invalid
          - upload_not_found
          - upload_state_error
          - upload_too_large
          - video_edit_model_not_supported
          - video_edit_source_must_be_video
          - video_edit_source_not_found
          - video_edit_source_required
          - voice_not_found
          - voice_required
        error:
          type: string
          description: Human-readable message.
      additionalProperties: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your KreatorFlow API key (kf_...) as a bearer token. Keep it on your server.
    apiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: Alternative to the Authorization header.
externalDocs:
  description: Developer docs
  url: https://developers.kreatorflow.ai/?section=docs
x-refined-from:
- developers.kreatorflow.ai-openapi.json
- kreatorflow-ai-openapi.json
x-job-error-codes:
- code: reference_rejected
  meaning: A reference did not pass screening.
- code: reference_asset_pending
  meaning: A new reference is still being reviewed.
- code: reference_asset_failed
  meaning: The reference did not pass review.
- code: generation_rejected
  meaning: The request was declined (prompt, reference or options).
- code: generation_timeout
  meaning: The job ran out of time after automatic retries.
- code: generation_unavailable
  meaning: The model is temporarily unavailable.
- code: generation_failed
  meaning: The generation failed.