Avala AI, Inc. Exports API

openapi: 3.2.0
info:
  title: Avala Exports API
  description: '# Authentication


    ## Generating an API Key


    The Avala SDK uses API keys to authenticate requests. You can create and manage your API keys from the

    Settings page of Mission Control.


    Follow these steps to generate a new API key:


    1. Open your settings page by clicking on your user avatar located at the top right-hand corner of any

    Mission Control screen, and select `Settings`.

    2. From the left-hand sub-menu, select `Security & Identity`.

    3. Click on `New API Key`, enter a name for the key, and then click `Create key`.


    The new key will be automatically copied to your clipboard. Please note, for security reasons, the key

    will not be accessible once you close the window. Ensure you store it in a safe location before closing

    the pop-up modal.


    ### Video walkthrough of API key generation


    ## Authenticating with an API Key


    This is the easiest part! Just add a header named `X-Avala-Api-Key` to your requests and set the

    previously generated API Key as the value.'
  termsOfService: https://avala.ai/legal/terms
  contact:
    email: support@avala.ai
  version: v1
servers:
- url: https://api.avala.ai/api/v1
security:
- API_Key: []
- JWT: []
tags:
- name: Exports
  description: To be completed...
paths:
  /exports/:
    parameters: []
    get:
      operationId: exports_list
      summary: /api/v1/exports/
      description: '### List all _exported_ results, check the _status_, and get the _download URL_'
      parameters:
      - name: ordering
        in: query
        description: Which field to use when ordering the results.
        required: false
        schema:
          type: string
      - name: cursor
        in: query
        description: The pagination cursor value.
        required: false
        schema:
          type: string
      - name: limit
        in: query
        description: Number of results to return per page.
        required: false
        schema:
          type: integer
      - name: order
        in: query
        description: Sets the CursorPagination `offset` when `cursor` is also set. e.g. `cursor=...&offset=1`
        schema:
          type: string
      - name: reverse
        in: query
        description: Sets the CursorPagination `reverse` when `cursor` is also set. e.g. `cursor=...&reverse=1`.
        schema:
          type: integer
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                required:
                - results
                type: object
                properties:
                  next:
                    type:
                    - string
                    - 'null'
                    format: uri
                  previous:
                    type:
                    - string
                    - 'null'
                    format: uri
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResultExport'
      tags:
      - Exports
    post:
      operationId: exports_create
      summary: /api/v1/exports/
      description: '### _Export_ all dataset or project _results_ (async)'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResultExport'
        required: true
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultExport'
      tags:
      - Exports
  /exports/formats/:
    parameters: []
    get:
      operationId: exports_formats
      description: ''
      parameters:
      - name: ordering
        in: query
        description: Which field to use when ordering the results.
        required: false
        schema:
          type: string
      - name: cursor
        in: query
        description: The pagination cursor value.
        required: false
        schema:
          type: string
      - name: limit
        in: query
        description: Number of results to return per page.
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportFormats'
      tags:
      - Exports
      summary: Exports formats
      x-summary-source: derived
components:
  schemas:
    ResultExport:
      required:
      - name
      - format
      - datasets
      - slices
      - projects
      type: object
      properties:
        uid:
          title: Uid
          type: string
          format: uuid
          readOnly: true
        name:
          title: Name
          type: string
          maxLength: 255
          minLength: 1
        format:
          title: Format
          type: string
          enum:
          - avala-json-external
          - YOLO
          - lerobot-v3
        filter_query_string:
          title: Filter query string
          type:
          - string
          - 'null'
        accepted_only:
          title: Accepted only
          type: boolean
          default: false
        error_code:
          title: Error code
          type: string
          readOnly: true
          minLength: 1
        total_task_count:
          title: Total task count
          type:
          - integer
          - 'null'
          readOnly: true
        exported_task_count:
          title: Exported task count
          type:
          - integer
          - 'null'
          readOnly: true
        download_url:
          title: Download url
          type:
          - string
          - 'null'
          readOnly: true
        status:
          title: Status
          type: string
          enum:
          - requested
          - aborted
          - exporting
          - exported
          - failed
          readOnly: true
        datasets:
          type: array
          items:
            type: string
            format: uuid
          uniqueItems: true
        slices:
          type: array
          items:
            type: string
            format: uuid
          uniqueItems: true
        projects:
          type: array
          items:
            type: string
            format: uuid
          uniqueItems: true
        organization:
          $ref: '#/components/schemas/Organization'
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
    ExportFormats:
      required:
      - formats
      type: object
      properties:
        formats:
          type: array
          items:
            type: string
            minLength: 1
    Organization:
      required:
      - name
      type:
      - object
      - 'null'
      properties:
        uid:
          title: Uid
          type: string
          format: uuid
          readOnly: true
        name:
          title: Name
          type: string
          maxLength: 1024
          minLength: 1
        slug:
          title: Slug
          type: string
          format: slug
          pattern: ^[-a-zA-Z0-9_]+$
          readOnly: true
          minLength: 1
        description:
          title: Description
          type: string
          maxLength: 1024
        logo:
          title: Logo
          type:
          - string
          - 'null'
          readOnly: true
          format: uri
        website:
          title: Website
          type: string
          format: uri
        public_slug:
          title: Public slug
          description: Canonical slug for URL rendering. Coworker viewers receive the organization's codename; others receive the real slug.
          type: string
          readOnly: true
  securitySchemes:
    JWT:
      type: apiKey
      name: Authorization
      in: header
      description: JWT token with 'JWT' prefix, e.g., 'JWT eyJhbGciOiJIUzI1NiIsInR...'
    API_Key:
      type: apiKey
      name: X-Avala-Api-Key
      in: header
      description: API key for authentication. Generate one in Mission Control Settings > Security & Identity.