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

# List jobs

> List jobs created by the current API key and environment.



## OpenAPI

````yaml /openapi.yaml get /jobs
openapi: 3.1.0
info:
  title: AI Gen Studio Image API
  version: 1.0.0
  summary: Image automation API for ecommerce visuals.
  description: >-
    The AI Gen Studio Image API provides focused endpoints for removing
    backgrounds, editing product images, creating AI edits, generating scenes,
    generating images, and producing ad creatives. Sandbox keys validate
    requests and return simulated results; live keys reserve paid credits and
    create asynchronous jobs.
servers:
  - url: https://aigenstudio.app/api/v1
    description: Production
security:
  - bearerApiKey: []
tags:
  - name: Create
    description: Create asynchronous image jobs.
  - name: Jobs
    description: List and inspect asynchronous jobs.
  - name: Catalog
    description: Discover available tools and current public credit costs.
paths:
  /jobs:
    get:
      tags:
        - Jobs
      summary: List jobs
      description: List jobs created by the current API key and environment.
      operationId: listJobs
      parameters:
        - name: api
          in: query
          schema:
            $ref: '#/components/schemas/ToolId'
        - name: status
          in: query
          schema:
            $ref: '#/components/schemas/JobStatus'
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
        - name: cursor
          in: query
          schema:
            type: string
            format: date-time
        - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        '200':
          description: Jobs returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobListResponse'
        '400':
          $ref: '#/components/responses/InvalidPayload'
        '401':
          $ref: '#/components/responses/InvalidApiKey'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
components:
  schemas:
    ToolId:
      type: string
      enum:
        - remove_background
        - image_editing
        - image_ai_edit
        - ai_background
        - image_generation
        - ad_creative
    JobStatus:
      type: string
      enum:
        - queued
        - processing
        - completed
        - failed
        - cancelled
        - partially_completed
    JobListResponse:
      type: object
      required:
        - jobs
        - next_cursor
        - request_id
      properties:
        jobs:
          type: array
          items:
            $ref: '#/components/schemas/JobSummary'
        next_cursor:
          type: string
          nullable: true
        request_id:
          type: string
    JobSummary:
      type: object
      required:
        - id
        - api
        - status
        - sandbox
        - total_results
        - credits_reserved
        - created_at
      properties:
        id:
          type: string
          format: uuid
        api:
          $ref: '#/components/schemas/ToolId'
        status:
          $ref: '#/components/schemas/JobStatus'
        sandbox:
          type: boolean
        total_results:
          type: integer
        completed_results:
          type: integer
        failed_results:
          type: integer
        credits_reserved:
          type: integer
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        completed_at:
          type: string
          format: date-time
          nullable: true
    ErrorResponse:
      type: object
      required:
        - error
        - request_id
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: object
        request_id:
          type: string
  parameters:
    RequestIdHeader:
      name: X-Request-Id
      in: header
      required: false
      schema:
        type: string
        maxLength: 160
      description: Optional client correlation id. AI Gen Studio also returns request_id.
  responses:
    InvalidPayload:
      description: Invalid request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InvalidApiKey:
      description: Invalid or missing API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    RateLimitExceeded:
      description: Rate limit exceeded.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerApiKey:
      type: http
      scheme: bearer
      bearerFormat: AI Gen Studio API key

````