Superlinked Ingestion API

openapi: 3.0.1
info:
  title: Superlinked Server Data Loader Ingestion 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: Ingestion
  description: Schema-generated endpoints that accept records and write embeddings to the connected vector database.
paths:
  /api/v1/ingest/{schema}:
    post:
      operationId: ingestRecords
      tags:
      - Ingestion
      summary: Ingest records for a schema
      description: Generated per schema declared in the Superlinked app. Accepts one or more records matching the schema's fields; the server computes multi-modal embeddings and persists them to the configured vector database. The {schema} path segment is the schema's id (for example, the lowercased schema class name).
      parameters:
      - name: schema
        in: path
        required: true
        description: Identifier of the Superlinked schema whose ingest endpoint is being called.
        schema:
          type: string
          example: paragraph
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IngestRequest'
      responses:
        '202':
          description: Accepted. Records were received and embedding/persistence was scheduled.
        '422':
          description: Request body did not match the generated schema.
components:
  schemas:
    IngestRequest:
      type: object
      description: Record payload whose fields are generated from the target schema. Field names and types shown here are illustrative.
      additionalProperties: true
      example:
        id: doc-1
        body: Example text to embed.
        rating: 5
  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.