Superlinked

Superlinked Query API

Schema-generated endpoints that run registered queries against the connected vector database.

Documentation GitHub OpenAPI

Operations 1

POST /api/v1/search/{query_name} Run a registered query #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/superlinked-query-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Superlinked Server Query API
  description: REST API auto-generated by the Superlinked Server from a Superlinked app's schema, index, and query definitions.
  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: Query
  description: Schema-generated endpoints that run registered queries against the connected vector database.
paths:
  /api/v1/search/{query_name}:
    post:
      operationId: runQuery
      tags:
      - Query
      summary: Run a registered query
      description: Generated per RestQuery registered in the Superlinked app. The request body parameters (for example natural_query, limit, and any query-time weights or filters) are derived from the query definition. Returns ranked entries from the connected vector store, optionally with metadata.
      parameters:
      - name: query_name
        in: path
        required: true
        description: Name of the registered RestQuery to execute.
        schema:
          type: string
          example: paragraph_query
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryRequest'
      responses:
        '200':
          description: Ranked query results.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResponse'
        '422':
          description: Request body did not match the generated query parameters.
components:
  schemas:
    QueryRequest:
      type: object
      description: Query parameters generated from the registered RestQuery. Parameter names shown here are illustrative; actual parameters depend on the query definition.
      properties:
        natural_query:
          type: string
          description: Natural-language query string, when the query defines one.
        limit:
          type: integer
          description: Maximum number of results to return.
      additionalProperties: true
      example:
        natural_query: comfortable hotel near the beach
        limit: 10
    QueryResponse:
      type: object
      description: Ranked results from the connected vector database.
      properties:
        entries:
          type: array
          items:
            type: object
            additionalProperties: true
      additionalProperties: true
  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.