Unisson onboarding API

The onboarding API from Unisson — 2 operation(s) for onboarding.

OpenAPI Specification

unisson-onboarding-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Unisson agent-evals onboarding API
  version: 1.0.0
tags:
- name: onboarding
paths:
  /api/v1/onboarding/status:
    get:
      tags:
      - onboarding
      summary: Get Onboarding Status
      description: Get current onboarding status for the user's organization.
      operationId: get_onboarding_status_api_v1_onboarding_status_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingStatusResponse'
      security:
      - HTTPBearer: []
  /api/v1/onboarding/complete:
    post:
      tags:
      - onboarding
      summary: Complete Onboarding
      description: Mark onboarding as complete and save organization settings.
      operationId: complete_onboarding_api_v1_onboarding_complete_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompleteOnboardingRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompleteOnboardingResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    OnboardingStatusResponse:
      properties:
        completed:
          type: boolean
          title: Completed
      type: object
      required:
      - completed
      title: OnboardingStatusResponse
    CompleteOnboardingRequest:
      properties:
        start_url:
          type: string
          title: Start Url
        allowed_domains:
          items:
            type: string
          type: array
          title: Allowed Domains
      type: object
      required:
      - start_url
      - allowed_domains
      title: CompleteOnboardingRequest
    CompleteOnboardingResponse:
      properties:
        success:
          type: boolean
          title: Success
      type: object
      required:
      - success
      title: CompleteOnboardingResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer