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 Document API

A Document represents an individual item stored within a Search Store. Documents can contain content from various modalities, such as text, images, or pre-chunked data.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 14 operations across 10 paths, and defines 22 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: {host}/v1/studio/data, {host}/v1/studio/search.

14 operations 10 paths 22 schemas 2 DELETE9 GET3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.aleph-alpha.com
Authentication
HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Aleph Alpha Document API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (Bearer). It accepts HTTP bearer tokens (token).

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

Paths & Operations 14

Across 10 paths, the API surfaces 14 operations — 2 DELETE, 9 GET, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Document 14

A Document represents an individual item stored within a Search Store. Documents can contain content from various modalities, such as text, images, or pre-chunked data.

GET
/search_stores/{searchStoreID}/documents
Lists the information of documents in a search store.
4 params → 200400404
PUT
/search_stores/{searchStoreID}/documents/{documentName}
Upload or update a document in the specified Search Store.
3 params body → 200400404
GET
/search_stores/{searchStoreID}/documents/{documentName}
Retrieve a document by name.
2 params → 200400404
DELETE
/search_stores/{searchStoreID}/documents/{documentName}
Remove a document from the search store.
2 params → 202400404
GET
/search_stores/{searchStoreID}/documents/{documentName}/content
Get the content of a document by name.
2 params → 200400404
PUT
/search_stores/{searchStoreID}/documents/{documentName}/metadata
Replaces a document's metadata.
2 params body → 200400404
GET
/search_stores/{searchStoreID}/documents/{documentName}/chunks
Get the chunks of a document.
2 params → 200400404
GET
/collections/{namespace}/{collection}/docs
List document information.
4 params → 200
GET
/collections/{namespace}/{collection}/docs/{name}
Get a document.
3 params → 200
PUT
/collections/{namespace}/{collection}/docs/{name}
Insert or update a document.
3 params body → 200
DELETE
/collections/{namespace}/{collection}/docs/{name}
Delete a document.
3 params → 200
GET
/collections/{namespace}/{collection}/docs/{name}/versions
Get all document versions.
3 params → 200
GET
/collections/{namespace}/{collection}/docs/{name}/versions/{version}
Get a specific version of a document.
4 params → 200
GET
/collections/{namespace}/{collection}/docs/{name}/indexes/{index}/chunks
Get document chunks for a given index.
4 params → 200

Schemas 22

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

DocumentInformationPage
object
4 properties
DocumentSection
object
A section of a document.
4 properties
NestedMetadata
object
Metadata attached to a search store file. This can be useful for storing additional structured information. Keys are strings with a maximum length of 64 charac…
image
object
Image data as base64-encoded bytes. Supperted types are PNG, JPG, GIF, BMP, WEBP.
2 properties 2 required
DocumentInformation
object
Information about a document
4 properties
Content
array
Image
object
Image data as base64-encoded bytes. Supported types are PNG, JPG, GIF, BMP, WEBP.
2 properties
documentInformation
object
Information about a document
3 properties
documentSection
object
A section of a document.
4 properties
imageCursor
object
A position within a document. The cursor is always inclusive of the current position, in both start and end positions.
2 properties
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
TextCursor
object
A position within a document. The cursor is always inclusive of the current position, in both start and end positions.
3 properties
documentVersion
object
The version of a document with the creation timestamp.
3 properties
documentPath
object
The path to a document. A path uniquely identifies a document among all managed documents.
3 properties
ModalityText
object
2 properties
text
object
Represent a single piece of continuous text. The modality must always be 'text'.
2 properties 2 required
document
object
Represents a document. The actual content of the document is an array of text and image elements. The version field allow to evolve the schema. The documentati…
3 properties 2 required
DocumentMetadata
object
1 property
DocumentContent
object
Represents a document. The actual content of the document is an array of text and image elements. The version field allow to evolve the schema. The documentati…
3 properties
ModalityImage
object
2 properties
textCursor
object
A position within a document. The cursor is always inclusive of the current position, in both start and end positions.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aleph-alpha-document-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 Downloads API
AE Profile APIs.io
Aleph Alpha Evaluation Datasets API
AE Profile APIs.io
Aleph Alpha Events API
AE Profile APIs.io
#Document
← Back to A APIs
API Details
ID
aleph-alpha:aleph-alpha-document-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-document-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/aleph-alpha-document-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 Document 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.