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

Aleph Alpha Search Store API

A Search Store is a structured data repository optimized for indexing and retrieving searchable entities. It supports full-text search, metadata-based filtering, and relevance ranking. Each Search Store can manage multiple indexed documents, making it ideal for fast, scalable information retrieval across different modalities.

Aleph Alpha Search Store 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 Search Store. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 4 paths, and defines 23 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

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

7 operations 4 paths 23 schemas 1 DELETE3 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.aleph-alpha.com
Authentication
HTTP Bearer
License
Open Aleph License
Resource Areas
1

Authentication & Security 1

Aleph Alpha Search Store API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (Bearer). By default, every request must be authenticated.

Paths & Operations 7

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

Search Store 7

A Search Store is a structured data repository optimized for indexing and retrieving searchable entities. It supports full-text search, metadata-based filtering, and relevance ran…

POST
/search_stores
Create a new Search Store instance for indexing and retrieval.
body → 201400
GET
/search_stores
Lists all search store.
2 params → 200400
GET
/search_stores/{searchStoreID}
Fetch details of a specific Search Store by its ID.
1 param → 200400404
PATCH
/search_stores/{searchStoreID}
Update metadata of an existing Search Store.
1 param body → 200400404
DELETE
/search_stores/{searchStoreID}
Delete a Search Store and all its associated documents.
1 param → 202400404
GET
/search_stores/{searchStoreID}/transitioning
Get count of all documents in a Search Store that are currently being embedded or archived.
1 param → 200400404
POST
/search_stores/{searchStoreID}/search
Perform a semantic search within the specified Search Store.
1 param body → 200400404

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are DocumentSection (4 properties), SearchStoreSearchRequest (4 properties), EmbeddingStrategyVllm (4 properties), SearchStoreProperties (4 properties). Each schema is shown below with its type and property counts.

ChunkingStrategy
object
2 properties
DocumentSection
object
A section of a document.
4 properties
EmbeddingStrategyInstruct
object
3 properties 2 required
SearchStoreInformation
SearchStoreMetadata
object
Metadata attached to a search store. This can be useful for storing additional structured information about the search store itself or the contained files. Key…
SearchStoreSearchRequest
object
4 properties
EmbeddingStrategySemantic
object
3 properties 2 required
Image
object
Image data as base64-encoded bytes. Supported types are PNG, JPG, GIF, BMP, WEBP.
2 properties
transitioningResult
object
The result for a transitioning documents query.
2 properties 2 required
SearchStoreProperties
object
4 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
Text
object
Represent a single piece of continuous text. The modality must always be 'text'.
2 properties
SearchStoreInformationPage
object
4 properties
CreatedAt
string
EmbeddingStrategyVllm
object
4 properties 1 required
SearchStoreQueryResult
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
SearchStoreCreate
SearchStoreUpdate
object
1 property
MetadataSchema
object
A dictionary of metadata fields on which to filter search results and their types. Field names must only contain alphanumeric characters, dashes and underscore…
ModalityText
object
2 properties
ModalityImage
object
2 properties
SearchStoreID
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aleph-alpha-search-store-api-openapi.yml Raw ↑

Other APIs Aleph Alpha publishes across the network.

Aleph Alpha API description API
Aleph Alpha Application Traces API
Aleph Alpha Benchmark Executions API
Aleph Alpha Benchmarks API
Aleph Alpha Cluster API
Aleph Alpha Collection API
Aleph Alpha Connectors API
Aleph Alpha Conversations API
Aleph Alpha Datasets API
Aleph Alpha Document API
Aleph Alpha Downloads API
Aleph Alpha Evaluation Datasets API
Where this information came from

This is an independent, third-party profile of Aleph Alpha Search Store 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.