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

# List Jobs

> List jobs associated with an experiment.

Use this tool when the caller needs execution, compression, analytics, or
related job history under one experiment. Returned ``job.id`` values can be
passed directly to ``get_job_results_and_status``.

When to Use:
    - Call this when the workflow already has an ``experiment_id`` but not
      the relevant ``job_id``.
    - Call this to inspect the complete job history for one experiment
      before polling individual jobs.

Constraints:
    - The result may contain heterogeneous job families.
    - ``limit`` caps the number of returned jobs.

Notes:
    - Returned ``job.id`` values can be passed directly to
      ``get_job_results_and_status``.
    - Agent-facing output should group jobs by type and status before
      expanding individual records.

Args:
    experiment_id: Parent experiment identifier.
    user: Authenticated user resolved from the API key.
    db: Active database session.
    limit: Maximum number of jobs to return. Defaults to ``100``.

Returns:
    A list of job objects capped by ``limit``.

Raises:
    HTTPException: Raised with ``404`` when the experiment is not available
        to the caller.



## OpenAPI

````yaml https://api.haiqu.ai/openapi.json get /ai/{experiment_id}/jobs
openapi: 3.1.0
info:
  title: Haiqu API
  summary: Haiqu RESTful API service.
  description: Cloud service providing the access to Haiqu cloud runtime
  contact:
    name: Haiqu Inc.
    url: https://haiqu.ai/
    email: info@haiqu.ai
  version: 1.4.0
servers: []
security: []
paths:
  /ai/{experiment_id}/jobs:
    get:
      summary: List Jobs
      description: >-
        List jobs associated with an experiment.


        Use this tool when the caller needs execution, compression, analytics,
        or

        related job history under one experiment. Returned ``job.id`` values can
        be

        passed directly to ``get_job_results_and_status``.


        When to Use:
            - Call this when the workflow already has an ``experiment_id`` but not
              the relevant ``job_id``.
            - Call this to inspect the complete job history for one experiment
              before polling individual jobs.

        Constraints:
            - The result may contain heterogeneous job families.
            - ``limit`` caps the number of returned jobs.

        Notes:
            - Returned ``job.id`` values can be passed directly to
              ``get_job_results_and_status``.
            - Agent-facing output should group jobs by type and status before
              expanding individual records.

        Args:
            experiment_id: Parent experiment identifier.
            user: Authenticated user resolved from the API key.
            db: Active database session.
            limit: Maximum number of jobs to return. Defaults to ``100``.

        Returns:
            A list of job objects capped by ``limit``.

        Raises:
            HTTPException: Raised with ``404`` when the experiment is not available
                to the caller.
      operationId: list_jobs_in_experiment
      parameters:
        - name: experiment_id
          in: path
          required: true
          schema:
            type: string
            title: Experiment Id
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 100
            title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BaseJobModel'
                title: Response List Jobs In Experiment
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyQuery: []
        - APIKeyHeader: []
components:
  schemas:
    BaseJobModel:
      properties:
        id:
          type: string
          title: Id
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        user_id:
          type: integer
          title: User Id
        experiment_id:
          type: string
          title: Experiment Id
        status:
          $ref: '#/components/schemas/JobStatus'
        job_type:
          $ref: '#/components/schemas/JobType'
        device_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Device Id
          default: Haiqu OS
        creation_date:
          type: string
          format: date-time
          title: Creation Date
        run_date:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Run Date
        finish_date:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Finish Date
        logs:
          anyOf:
            - type: string
            - type: 'null'
          title: Logs
        quality:
          anyOf:
            - type: number
            - type: 'null'
          title: Quality
        info:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Info
        time:
          anyOf:
            - type: number
            - type: 'null'
          title: Time
        parameters:
          anyOf:
            - additionalProperties: true
              type: object
            - items: {}
              type: array
            - type: 'null'
          title: Parameters
      type: object
      required:
        - id
        - user_id
        - experiment_id
        - status
        - job_type
        - creation_date
      title: BaseJobModel
      description: |-
        Base schema for all jobs: data loading, execution, analytics,
        logged local jobs, etc.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    JobStatus:
      type: string
      enum:
        - Submitted
        - Initializing
        - Queued
        - Validating
        - Running
        - Cancelled
        - Done
        - Error
      title: JobStatus
      description: Class for job status.
    JobType:
      type: string
      enum:
        - User local job
        - Analytics
        - Device specific analytics
        - Data Loading
        - Hybrid
        - Run
        - State Compression
        - Transpilation
        - Variational
        - Pretraining
        - SKQD
      title: JobType
      description: Class for job types.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    APIKeyQuery:
      type: apiKey
      in: query
      name: HAIQU_API_KEY
    APIKeyHeader:
      type: apiKey
      in: header
      name: authorization

````