SandboxAQ Inventory API

The inventory API from SandboxAQ — 1 operation(s) for inventory.

OpenAPI Specification

sandboxaq-inventory-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  contact: {}
  description: Flint AI Platform API
  license:
    name: Flint AI
    url: https://www.sandboxaq.com/legal/eula
  title: Flint AI Platform Inventory API
  version: 1.0.0
servers:
- description: Flint AI Platform (per-tenant instance)
  url: https://{instance}.flintai.dev/api/v1
  variables:
    instance:
      default: your-instance
      description: Your Flint AI instance subdomain
tags:
- name: inventory
paths:
  /sensors-used/tenants/{tenant_id}/workspaces/{workspace_id}:
    get:
      operationId: GetSensorsUsed
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  type: string
                type: array
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/common.RequestError'
          description: Unauthorized
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/common.RequestError'
          description: Failed to fetch sensors used
      security:
      - BearerAuth: []
      summary: Get all sensor types that have ever been used
      tags:
      - inventory
components:
  schemas:
    common.RequestError:
      description: Error responses returned by the API
      properties:
        code:
          example: 400
          type: integer
        message:
          example: Invalid request
          type: string
      required:
      - code
      - message
      type: object
  securitySchemes:
    BearerAuth:
      description: Use this header with a Bearer token to authenticate requests.
      in: header
      name: Authorization
      type: apiKey