Avala AI, Inc. Session Definitions API

openapi: 3.2.0
info:
  title: Avala Session Definitions 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: session-definitions
paths:
  /session-definitions/{session_definition_uid}/capture_examples/:
    parameters:
    - name: session_definition_uid
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: session-definitions_capture_examples_list
      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
      - name: project_uid
        in: query
        description: Project/campaign UID that bounds capture examples for shared session definitions.
        required: true
        schema:
          type: string
      - name: status
        in: query
        description: 'Result status from: accepted, or rejected.'
        schema:
          type: string
          enum:
          - accepted
          - rejected
      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/CaptureExample'
        '503':
          description: 'Matching stopped because the required coworker profile is missing. JSON: {"error_code": "coworker_profile_unavailable"}. No profile repair is performed.'
      tags:
      - session-definitions
      summary: Session definitions capture examples list
      x-summary-source: derived
components:
  schemas:
    CaptureExample:
      required:
      - uid
      - status
      type: object
      properties:
        uid:
          title: Uid
          type: string
          format: uuid
        status:
          title: Status
          type: string
          minLength: 1
        capture:
          title: Capture
          type: object
          readOnly: true
        capture_reject_reason:
          title: Capture reject reason
          type:
          - string
          - 'null'
          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.