Fleet Task Groups API

openapi: 3.2.0
info:
  title: Fleet Orchestrator Task Groups API
  version: 0.1.0
servers:
- url: https://orchestrator.fleetai.com
  description: Fleet Orchestrator (named by the official fleet-python SDK)
tags:
- name: task-groups
paths:
  /v1/task-groups:
    post:
      tags:
      - task-groups
      summary: Create Task Group Route
      operationId: create_task_group_route_v1_task_groups_post
      security:
      - HTTPBearer: []
      parameters:
      - name: X-JWT-Token
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Jwt-Token
      - name: X-Team-ID
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Team-Id
      - name: X-API-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: Authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskGroupCreateRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskGroupResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/task-groups/{task_group_id}:
    get:
      tags:
      - task-groups
      summary: Get Task Group Route
      operationId: get_task_group_route_v1_task_groups__task_group_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: task_group_id
        in: path
        required: true
        schema:
          type: string
          title: Task Group Id
      - name: X-JWT-Token
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Jwt-Token
      - name: X-Team-ID
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Team-Id
      - name: X-API-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: Authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskGroupResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    TaskGroupCreateRequest:
      properties:
        project_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Id
        name:
          type: string
          minLength: 1
          title: Name
        task:
          anyOf:
          - $ref: '#/components/schemas/TaskGroupTaskSpec'
          - type: 'null'
          description: Shared parent-task fields for PROMPT mode. Required when members carry prompts; must be omitted in REFERENCE mode.
        members:
          items:
            $ref: '#/components/schemas/TaskGroupMemberSpec'
          type: array
          minItems: 1
          title: Members
          description: Members. In PROMPT mode each carries a prompt; in REFERENCE mode each carries an eval_task_id (+ optional eval_task_version_id).
      additionalProperties: false
      type: object
      required:
      - name
      - members
      title: TaskGroupCreateRequest
    TaskGroupMemberSpec:
      properties:
        prompt:
          anyOf:
          - type: string
            minLength: 1
          - type: 'null'
          title: Prompt
        label:
          anyOf:
          - type: string
            minLength: 1
          - type: 'null'
          title: Label
        env_variables:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Env Variables
          description: Overrides the shared task.env_variables for this member.
        eval_task_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Eval Task Id
        eval_task_version_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Eval Task Version Id
      additionalProperties: false
      type: object
      title: TaskGroupMemberSpec
      description: 'One task-group member, in one of two shapes.


        PROMPT mode (legacy): carries a ``prompt`` (and optionally ``env_variables``)

        that becomes a new ``eval_task_version`` under the shared task.


        REFERENCE mode (new): carries an existing ``eval_task_id`` and optionally a

        pinned ``eval_task_version_id``. When the version is omitted the server pins

        the task''s latest (current) version.'
    TaskGroupResponse:
      properties:
        id:
          type: string
          title: Id
        task_group_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Task Group Id
        eval_task_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Eval Task Id
        team_id:
          type: string
          title: Team Id
        project_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Id
        name:
          type: string
          title: Name
        created_by:
          anyOf:
          - type: string
          - type: 'null'
          title: Created By
        created_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Created At
        updated_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Updated At
        members:
          items:
            $ref: '#/components/schemas/TaskGroupMemberResponse'
          type: array
          title: Members
        warnings:
          items:
            type: string
          type: array
          title: Warnings
      type: object
      required:
      - id
      - team_id
      - name
      - members
      title: TaskGroupResponse
    TaskGroupTaskSpec:
      properties:
        key:
          type: string
          title: Key
        prompt:
          type: 'null'
          title: Prompt
          description: Prompt belongs on each task-group member.
        env_id:
          type: string
          title: Environment Id
        verifier_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Verifier Id
        verifier_func:
          anyOf:
          - type: string
          - type: 'null'
          title: Verifier Func
        version:
          anyOf:
          - type: string
          - type: 'null'
          title: Version
        environment_version_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Environment Version Id
        seed_override:
          anyOf:
          - $ref: '#/components/schemas/SeedOverride'
          - type: 'null'
        seed_config:
          anyOf:
          - additionalProperties:
              additionalProperties:
                type: string
              type: object
            type: object
          - type: 'null'
          title: Seed Config
        env_variables:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Env Variables
        metadata:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Metadata
        expected_version_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Expected Version Id
          description: Current task version; required when replacing an existing task's tool policy.
        project_key:
          type: 'null'
          title: Project Key
          description: Derived from project_id for every created member task.
        data_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Data Id
        data_version:
          anyOf:
          - type: string
          - type: 'null'
          title: Data Version
        multi_app_seed_versions:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - type: 'null'
          title: Data Versions
          description: Per-component seed version pins. Keyed by component env_key; falls back to data_version for components not in the dict.
        verifier_status:
          type: string
          title: Verifier Status
          description: Status for the verifier version (ACTIVE or PROPOSED)
          default: ACTIVE
        output_json_schema:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Output Json Schema
          description: JSON schema for expected output format
        factual_answer:
          anyOf:
          - {}
          - type: 'null'
          title: Factual Answer
          description: Expected answer for research/factual tasks
        graded:
          type: 'null'
          title: Graded
          description: Task groups do not accept grading targets here.
        task_modality:
          anyOf:
          - type: string
          - type: 'null'
          title: Task Modality
          description: Task modality (computer_use, tool_use, browser)
        task_scenario_id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Task Scenario ID
          description: ID of an existing task scenario to link this task to
        task_lifecycle_status:
          anyOf:
          - type: string
          - type: 'null'
          title: Task Lifecycle Status
          description: Task lifecycle status (production, staging, development, deprecated)
      additionalProperties: false
      type: object
      required:
      - key
      - env_id
      title: TaskGroupTaskSpec
      description: 'Shared parent-task fields for task-group creation.


        Carries everything the underlying ``db.create_task`` needs EXCEPT the

        prompt (the prompt lives per-member on ``eval_task_versions``). Field names

        inherit from ``TaskRequest`` so task-create fields stay in sync with the

        standalone create-task API.'
    TaskGroupMemberResponse:
      properties:
        id:
          type: string
          title: Id
        task_group_id:
          type: string
          title: Task Group Id
        eval_task_id:
          type: string
          title: Eval Task Id
        eval_task_version_id:
          type: string
          title: Eval Task Version Id
        label:
          anyOf:
          - type: string
          - type: 'null'
          title: Label
        created_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Created At
        updated_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Updated At
      type: object
      required:
      - id
      - task_group_id
      - eval_task_id
      - eval_task_version_id
      title: TaskGroupMemberResponse
    SeedOverride:
      properties:
        seed_version_ids:
          items:
            type: string
          type: array
          maxItems: 32
          title: Seed Version Ids
          description: Complete seed-version selection; an empty list is valid for seedless releases.
      additionalProperties: false
      type: object
      required:
      - seed_version_ids
      title: SeedOverride
      description: A complete registered seed set for a pinned environment release.
    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
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer