openapi: 3.0.1
info:
  title: Superlinked Server Data Loader API
  description: REST API auto-generated by the Superlinked Server from a Superlinked app's schema, index, and query definitions. The Superlinked open-source Python framework (Apache-2.0) lets you declare Schema, Space, Index, Query, Source, and Executor objects; when run with a RestExecutor / RestApp the server exposes ingestion and query endpoints whose exact paths and request bodies are derived from those definitions. This document models the generated pattern using representative, templated path and body names ({schema}, {query_name}); the concrete endpoints on any given deployment depend on the app's own schema and registered queries. The framework repository was archived on 2026-05-29 as the team shifted to the Superlinked Inference Engine; the server REST pattern documented here reflects the framework as last published.
  termsOfService: https://www.superlinked.com
  contact:
    name: Superlinked
    url: https://www.superlinked.com
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  version: '1.0'
servers:
- url: http://localhost:8080
  description: Default local Superlinked Server. Replace with your deployed host or Superlinked Cloud endpoint.
tags:
- name: Data Loader
  description: Endpoints to trigger and monitor configured batch data loaders.
paths:
  /data-loader/{name}/run:
    post:
      operationId: runDataLoader
      tags:
      - Data Loader
      summary: Trigger a configured data loader
      description: Starts a configured batch data loader to backfill vectors from a file or external source.
      parameters:
      - name: name
        in: path
        required: true
        description: Name of the configured data loader.
        schema:
          type: string
          example: review
      responses:
        '202':
          description: Data loader run accepted.
  /data-loader/{name}/status:
    get:
      operationId: getDataLoaderStatus
      tags:
      - Data Loader
      summary: Get data loader status
      description: Reports the progress and state of a configured data loader.
      parameters:
      - name: name
        in: path
        required: true
        description: Name of the configured data loader.
        schema:
          type: string
          example: review
      responses:
        '200':
          description: Current data loader status.
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Optional API key header. The open-source Superlinked Server ships without built-in auth; deployments commonly place an API key or bearer token check in front of it (gateway or custom middleware). Configure to match your deployment.
    bearerAuth:
      type: http
      scheme: bearer
      description: Optional bearer token, when the deployment fronts the server with token auth.