Aleph Alpha Service API

Service health and status

Operations 3

GET / Ping the Document Index.
GET /health/liveness Liveness state of the Document Index.
GET /health/readiness Readiness state of the Document Index.

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/aleph-alpha-service-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.

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

OpenAPI Specification

aleph-alpha-service-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Aleph Alpha Document Index Service API
  version: 0.0.0
  description: 'The Document Index is a service that provides semantic search over your knowledge base. It

    takes care of the chunking and embedding of your documents, and it keeps these embeddings in

    sync when your documents change.

    '
  contact:
    email: support@aleph-alpha.com
servers:
- url: '{host}/v1/studio/search'
  variables:
    host:
      default: https://api.pharia.example.com
tags:
- name: Service
  description: Service health and status
paths:
  /:
    get:
      tags:
      - Service
      security:
      - token: []
      summary: Ping the Document Index.
      responses:
        '200':
          description: Hello!
          content:
            text/plain:
              schema:
                type: string
                example: Hello from the Document Index!
  /health/liveness:
    get:
      tags:
      - Service
      security:
      - token: []
      summary: Liveness state of the Document Index.
      responses:
        '200':
          description: The Document Index is alive
  /health/readiness:
    get:
      tags:
      - Service
      security:
      - token: []
      summary: Readiness state of the Document Index.
      responses:
        '200':
          description: The Document Index is ready to receive requests
components:
  securitySchemes:
    token:
      type: http
      scheme: bearer
      description: Can be generated in your [Aleph Alpha profile](https://app.aleph-alpha.com/profile)