Avala AI, Inc. Slices API

openapi: 3.2.0
info:
  title: Avala Slices 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: slices
paths:
  /slices/:
    parameters: []
    post:
      operationId: slices_create
      description: ''
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SliceCreate'
        required: true
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Slice'
      tags:
      - slices
      summary: Slices create
      x-summary-source: derived
  /slices/{owner_name}/list/:
    parameters:
    - name: owner_name
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: slices_list_list
      description: Slices belonging to an owner that are visible to the current user
      parameters:
      - name: ordering
        in: query
        description: Which field to use when ordering the results.
        required: false
        schema:
          type: string
      - name: page
        in: query
        description: A page number within the paginated result set.
        required: false
        schema:
          type: integer
      - 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:
                - count
                - results
                type: object
                properties:
                  count:
                    type: integer
                  next:
                    type:
                    - string
                    - 'null'
                    format: uri
                  previous:
                    type:
                    - string
                    - 'null'
                    format: uri
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/Slice'
      tags:
      - slices
      summary: Slices list list
      x-summary-source: derived
  /slices/{owner_name}/{slice_slug}/:
    parameters:
    - name: owner_name
      in: path
      required: true
      schema:
        type: string
    - name: slice_slug
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: slices_read
      description: Slice
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Slice'
      tags:
      - slices
      summary: Slices read
      x-summary-source: derived
  /slices/{owner_name}/{slice_slug}/items/list/:
    parameters:
    - name: owner_name
      in: path
      required: true
      schema:
        type: string
    - name: slice_slug
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: slices_items_list_list
      description: Slice items (e.g. images from associated datasets)
      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/DatasetListItem'
      tags:
      - slices
      summary: Slices items list list
      x-summary-source: derived
  /slices/{owner_name}/{slice_slug}/items/{item_uid}/:
    parameters:
    - name: owner_name
      in: path
      required: true
      schema:
        type: string
    - name: slice_slug
      in: path
      required: true
      schema:
        type: string
    - name: item_uid
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: slices_items_read
      description: Slice items (e.g. images from associated datasets)
      parameters:
      - name: project_id
        in: query
        description: Show only items with tasks from given project
        schema:
          type: string
      - name: status
        in: query
        description: Show only tasks with given status
        schema:
          type: string
          enum:
          - all
          - complete
          - pending
          - skipped
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetItem'
      tags:
      - slices
      summary: Slices items read
      x-summary-source: derived
components:
  schemas:
    DatasetItem:
      required:
      - key
      type: object
      properties:
        id:
          title: Id
          type: integer
          readOnly: true
        uid:
          title: Uid
          type: string
          format: uuid
          readOnly: true
        dataset:
          title: Dataset
          type: string
          readOnly: true
        dataset_owner_name:
          title: Dataset owner name
          description: Owner handle/slug of the item's source dataset, for dataset-scoped URLs (e.g. the image-segmentation submit endpoint). A slice can reference datasets owned by other users/orgs, so this is not necessarily the slice owner.
          type: string
          readOnly: true
          minLength: 1
        dataset_slug:
          title: Dataset slug
          description: Slug of the item's source dataset.
          type: string
          readOnly: true
          minLength: 1
        url:
          title: Url
          type: string
          readOnly: true
          minLength: 1
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        updated_at:
          title: Updated at
          type: string
          format: date-time
          readOnly: true
        key:
          title: Key
          type: string
          maxLength: 1024
          minLength: 1
        gpu_texture_url:
          title: Gpu texture url
          type: string
          readOnly: true
        metadata:
          title: Metadata
          type: object
        thumbnails:
          type: array
          items:
            type:
            - string
            - 'null'
          readOnly: true
        video_thumbnail:
          title: Video thumbnail
          description: Get the URL for the video thumbnail (.webm clip) if available.
          type: string
          readOnly: true
          minLength: 1
        export_snippet:
          title: Export snippet
          type:
          - object
          - 'null'
          readOnly: true
        annotations:
          $ref: '#/components/schemas/DatasetItemAnnotationList'
        crop_data:
          $ref: '#/components/schemas/DatasetItemCrop'
        related_items:
          type: array
          items:
            $ref: '#/components/schemas/RelatedItem'
          readOnly: true
        related_sequence_uid:
          title: Related sequence uid
          type: string
          format: uuid
          readOnly: true
        is_hidden:
          title: Is hidden
          type: boolean
          readOnly: true
        masks_fingerprint:
          title: Masks fingerprint
          description: Fingerprint of the segmentation masks in export_snippet. Send it back in the X-Avala-Masks-Fingerprint header when saving masks through the image-segmentation endpoint; the save is refused with 409 (code masks_fingerprint_conflict) if the item's masks changed since. Null when unknown; then send no header.
          type:
          - string
          - 'null'
          readOnly: true
          minLength: 1
    SubSliceArray:
      description: "\nAn Array of sub slice objects. The available `sub_slice` types are:\n\n- `dataset_items`: a preselected list of dataset items in a dataset\n```\n{\n    \"type\": \"dataset_items\",\n    \"dataset_uid\": <dataset_uid>\n    \"dataset_item_uids\": [\n        <dataset_item_uid>,\n        <dataset_item_uid>\n        ...\n    ]\n}\n```\n- `dataset`: all dataset items in selected dataset\n```\n{\n    \"type\": \"dataset\",\n    \"dataset_uid\": <dataset_uid>\n}\n```\n- `filters`: selects dataset items from dataset by applying filter expressions\n```\n{\n    \"type\": \"filters\",\n    \"dataset_uid\": <dataset_uid>,\n    \"filters\":\n        <filter_expression>,\n}\n```\n"
      required:
      - type
      type: object
      properties:
        type:
          title: Type
          description: '

            Type of the sub slice. Depending on the type, certain other properties are required. Possible values are:

            - dataset_items

            - dataset

            - filters

            '
          type: string
          enum:
          - dataset_items
          - dataset
          - filters
        dataset_uid:
          title: Dataset uid
          description: The UID of the selected dataset
          type: string
          format: uuid
        dataset_item_uids:
          type: array
          items:
            type: string
            format: uuid
        filters:
          title: Filters
          type: object
          additionalProperties:
            type: array
            items:
              type: string
              minLength: 1
    SliceCreate:
      required:
      - name
      - visibility
      - sub_slices
      type: object
      properties:
        name:
          title: Name
          type: string
          maxLength: 100
          minLength: 1
        uid:
          title: Uid
          type: string
          format: uuid
          readOnly: true
        organization:
          $ref: '#/components/schemas/Organization'
        visibility:
          title: Visibility
          description: Visibility setting for the slice.
          type: string
          enum:
          - public
          - private
        sub_slices:
          description: "\nAn Array of sub slice objects. The available `sub_slice` types are:\n\n- `dataset_items`: a preselected list of dataset items in a dataset\n```\n{\n    \"type\": \"dataset_items\",\n    \"dataset_uid\": <dataset_uid>\n    \"dataset_item_uids\": [\n        <dataset_item_uid>,\n        <dataset_item_uid>\n        ...\n    ]\n}\n```\n- `dataset`: all dataset items in selected dataset\n```\n{\n    \"type\": \"dataset\",\n    \"dataset_uid\": <dataset_uid>\n}\n```\n- `filters`: selects dataset items from dataset by applying filter expressions\n```\n{\n    \"type\": \"filters\",\n    \"dataset_uid\": <dataset_uid>,\n    \"filters\":\n        <filter_expression>,\n}\n```\n"
          type: array
          items:
            $ref: '#/components/schemas/SubSliceArray'
        random_selection_count:
          title: Random selection count
          type:
          - integer
          - 'null'
    DatasetItemAnnotationNode:
      required:
      - annotation_info
      - status
      - uid
      - project_index
      - children
      type: object
      properties:
        annotation_info:
          $ref: '#/components/schemas/DatasetItemAnnotation'
        status:
          title: Status
          type: string
          minLength: 1
        uid:
          title: Uid
          type: string
          minLength: 1
        project_index:
          title: Project index
          type:
          - integer
          - 'null'
        annotator:
          $ref: '#/components/schemas/AnnotationUser'
        reviewer:
          $ref: '#/components/schemas/AnnotationUser'
        children:
          type: array
          items:
            $ref: '#/components/schemas/DatasetItemAnnotationNode'
    CropAnnotationsIn2dSerailizer:
      required:
      - z
      - classes
      type:
      - object
      - 'null'
      properties:
        z:
          title: Z
          type: number
        classes:
          type: array
          items:
            type: string
            minLength: 1
          minItems: 1
    RelatedItem:
      required:
      - sensor_id
      - sensor_index
      - uid
      type: object
      properties:
        sensor_id:
          title: Sensor id
          type:
          - string
          - 'null'
          minLength: 1
        sensor_index:
          title: Sensor index
          type:
          - integer
          - 'null'
        uid:
          title: Uid
          type:
          - string
          - 'null'
          format: uuid
    AnnotationProject:
      required:
      - name
      type: object
      properties:
        uid:
          title: Uid
          type: string
          format: uuid
          readOnly: true
        name:
          title: Name
          type: string
          maxLength: 100
          minLength: 1
    DatasetListItem:
      required:
      - key
      type: object
      properties:
        id:
          title: Id
          type: integer
          readOnly: true
        uid:
          title: Uid
          type: string
          format: uuid
          readOnly: true
        key:
          title: Key
          type: string
          maxLength: 1024
          minLength: 1
        dataset:
          title: Dataset
          type: string
          readOnly: true
        url:
          title: Url
          type: string
          readOnly: true
          minLength: 1
        gpu_texture_url:
          title: Gpu texture url
          type: string
          readOnly: true
        thumbnails:
          type: array
          items:
            type:
            - string
            - 'null'
          readOnly: true
        video_thumbnail:
          title: Video thumbnail
          description: Get the URL for the video thumbnail (.webm clip) if available.
          type: string
          readOnly: true
          minLength: 1
        metadata:
          title: Metadata
          type: object
        export_snippet:
          title: Export snippet
          type:
          - object
          - 'null'
          readOnly: true
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        updated_at:
          title: Updated at
          type: string
          format: date-time
          readOnly: true
        crop_data:
          $ref: '#/components/schemas/DatasetItemCrop'
        related_items:
          type: array
          items:
            $ref: '#/components/schemas/RelatedItem'
          readOnly: true
        related_sequence_uid:
          title: Related sequence uid
          type: string
          format: uuid
          readOnly: true
        is_hidden:
          title: Is hidden
          type: boolean
          readOnly: true
    AnnotationUser:
      required:
      - username
      type: object
      properties:
        uid:
          title: Uid
          type: string
          format: uuid
          readOnly: true
        full_name:
          title: Full name
          type: string
          readOnly: true
        username:
          title: Username
          description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
          type: string
          pattern: ^[\w.@+-]+$
          maxLength: 150
          minLength: 1
        picture:
          title: Picture
          type:
          - string
          - 'null'
          format: uri
          maxLength: 2048
    Slice:
      required:
      - name
      - slug
      type: object
      properties:
        name:
          title: Name
          type: string
          maxLength: 100
          minLength: 1
        slug:
          title: Slug
          type: string
          maxLength: 100
          minLength: 1
        uid:
          title: Uid
          type: string
          format: uuid
          readOnly: true
        owner_name:
          title: Owner name
          description: The name of the slice owner
          type: string
          readOnly: true
          minLength: 1
        organization:
          $ref: '#/components/schemas/Organization'
        visibility:
          title: Visibility
          type: string
          enum:
          - public
          - private
        sub_slices:
          type: array
          items:
            $ref: '#/components/schemas/SubSliceArray'
          readOnly: true
        source_data:
          title: Source data
          type:
          - object
          - 'null'
        status:
          title: Status
          type: string
          enum:
          - pending
          - created
          - failed
        featured_slice_item_urls:
          description: List of the first 4 found slice items' URL
          type: array
          items:
            type:
            - string
            - 'null'
          readOnly: true
        item_count:
          title: Item count
          type: integer
          readOnly: true
    DatasetItemAnnotationList:
      required:
      - nodes
      - projects
      type: object
      properties:
        nodes:
          type: array
          items:
            $ref: '#/components/schemas/DatasetItemAnnotationNode'
        projects:
          type: array
          items:
            $ref: '#/components/schemas/AnnotationProject'
    DatasetItemAnnotation:
      required:
      - task_name
      - task_object
      - object_uuid
      type: object
      properties:
        task_name:
          title: Task name
          type: string
          minLength: 1
        task_object:
          title: Task object
          type: string
          minLength: 1
        object_uuid:
          title: Object uuid
          type:
          - string
          - 'null'
          minLength: 1
        data:
          title: Data
          type: object
          readOnly: true
    DatasetItemCrop:
      type: object
      properties:
        crop_annotations_in_2d:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CropAnnotationsIn2dSerailizer'
        crop_annotations_polygon_mask:
          description: 'List of coordinates for the polygon mask in the format: [[x1, y1], ..., [xN, yN]].'
          type:
          - array
          - 'null'
          items:
            type: array
            items:
              type: number
            maxItems: 2
            minItems: 2
          readOnly: true
          minItems: 3
        where:
          title: Where
          type:
          - string
          - 'null'
          enum:
          - dataset
          - sequence
          - frame
          - dataset_item
          - null
    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.