How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Aleph Alpha

Aleph Alpha Index API

Management of search indexes

Documentation Provider Profile APIs.io OpenAPI GitHub

Aleph Alpha Index API is one of 37 APIs that Aleph Alpha publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Index. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 9 operations across 6 paths, and defines 13 schemas. It is described by OpenAPI 3.2.0, at version 0.0.0.

Requests are made against a single base URL, {host}/v1/studio/search.

9 operations 6 paths 13 schemas 2 DELETE4 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.0.0
Base URL
https://api.aleph-alpha.com
Authentication
HTTP Bearer
Contact
support@aleph-alpha.com
Resource Areas
1

Authentication & Security 1

Aleph Alpha Index API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (token).

  • token — Can be generated in your [Aleph Alpha profile](https://app.aleph-alpha.com/profile)

Paths & Operations 9

Across 6 paths, the API surfaces 9 operations — 2 DELETE, 4 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Index 9

Management of search indexes

GET
/indexes/{namespace}
List of index configurations in namespace.
1 param → 200
GET
/indexes/{namespace}/{index}
Get a namespace-wide index configuration.
2 params → 200
PUT
/indexes/{namespace}/{index}
Define a namespace-wide index configuration.
2 params body → 200
DELETE
/indexes/{namespace}/{index}
Delete a namespace-wide index configuration.
2 params → 200409
GET
/collections/{namespace}/{collection}/indexes
Get path of indexes assigned to the given collection.
2 params → 200
PUT
/collections/{namespace}/{collection}/indexes/{index}
Assign an existing index config to an existing collection.
3 params → 200
DELETE
/collections/{namespace}/{collection}/indexes/{index}
Removes an index from collection.
3 params → 200
POST
/collections/{namespace}/{collection}/indexes/{index}/search
Index based search.
3 params body → 200
GET
/collections/{namespace}/{collection}/indexes/{index}/export/embedding_projector
Exports embeddings in Embedding Projector format.
3 params → 200

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are indexConfig (5 properties), documentSection (4 properties), searchQueryParameters (4 properties), documentPath (3 properties). Each schema is shown below with its type and property counts.

filterConditions
array
A collection of filter conditions that are combined according to the parent filter combinator.
documentSection
object
A section of a document.
4 properties
image
object
Image data as base64-encoded bytes. Supperted types are PNG, JPG, GIF, BMP, WEBP.
2 properties 2 required
imageCursor
object
A position within a document. The cursor is always inclusive of the current position, in both start and end positions.
2 properties
queryResult
array
The result for semantic document search. An array of document names and content of the found documents in the given collection.
textCursor
object
A position within a document. The cursor is always inclusive of the current position, in both start and end positions.
3 properties
documentPath
object
The path to a document. A path uniquely identifies a document among all managed documents.
3 properties
filter
object
A logical combination of filter conditions.
text
object
Represent a single piece of continuous text. The modality must always be 'text'.
2 properties 2 required
metadataFilterField
string
The metadata field on which to filter search results. Field names must only contain alphanumeric characters, dashes and underscores. Nested fields can be speci…
indexConfig
object
Represents the configuration of an index. You can assign indexes to collections and use them for efficient content-based searching.
5 properties 1 required
searchQueryParameters
object
The parameters for finding document sections within a collection based on a semantic search.
4 properties 1 required
query
array
Represents a query as is an array of text and image elements.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aleph-alpha-index-api-openapi.yml Raw ↑

Other APIs Aleph Alpha publishes across the network.

Aleph Alpha API description API
AE Profile APIs.io
Aleph Alpha Application Traces API
AE Profile APIs.io
Aleph Alpha Benchmark Executions API
AE Profile APIs.io
Aleph Alpha Benchmarks API
AE Profile APIs.io
Aleph Alpha Cluster API
AE Profile APIs.io
Aleph Alpha Collection API
AE Profile APIs.io
Aleph Alpha Connectors API
AE Profile APIs.io
Aleph Alpha Conversations API
AE Profile APIs.io
Aleph Alpha Datasets API
AE Profile APIs.io
Aleph Alpha Document API
AE Profile APIs.io
Aleph Alpha Downloads API
AE Profile APIs.io
Aleph Alpha Evaluation Datasets API
AE Profile APIs.io
#Index
← Back to A APIs
API Details
ID
aleph-alpha:aleph-alpha-index-api
Base URL
https://api.aleph-alpha.com
Docs
https://docs.aleph-alpha.com/phariaai-dev-guide/latest/pharia-openapi/pharia-inference/index.html
Provider
Aleph Alpha
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=aleph-alpha-index-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/aleph-alpha-index-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Aleph Alpha Index API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.