# Aleph Alpha Document API

**Canonical:** https://apis.io/apis/aleph-alpha/aleph-alpha-document-api/  
**Provider:** Aleph Alpha — https://apis.io/providers/aleph-alpha/  
**Base URL:** https://api.aleph-alpha.com  
**Documentation:** https://docs.aleph-alpha.com/phariaai-dev-guide/latest/pharia-openapi/pharia-inference/index.html

Aleph Alpha Document API is one of 37 APIs that [Aleph Alpha](https://apis.io/providers/aleph-alpha/) publishes on the [APIs.io](https://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.

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.

## Operations (14)

| Method | Path | Summary |
|---|---|---|
| GET | `/search_stores/{searchStoreID}/documents` | Lists the information of documents in a search store. |
| PUT | `/search_stores/{searchStoreID}/documents/{documentName}` | Upload or update a document in the specified Search Store. |
| GET | `/search_stores/{searchStoreID}/documents/{documentName}` | Retrieve a document by name. |
| DELETE | `/search_stores/{searchStoreID}/documents/{documentName}` | Remove a document from the search store. |
| GET | `/search_stores/{searchStoreID}/documents/{documentName}/content` | Get the content of a document by name. |
| PUT | `/search_stores/{searchStoreID}/documents/{documentName}/metadata` | Replaces a document's metadata. |
| GET | `/search_stores/{searchStoreID}/documents/{documentName}/chunks` | Get the chunks of a document. |
| GET | `/collections/{namespace}/{collection}/docs` | List document information. |
| GET | `/collections/{namespace}/{collection}/docs/{name}` | Get a document. |
| PUT | `/collections/{namespace}/{collection}/docs/{name}` | Insert or update a document. |
| DELETE | `/collections/{namespace}/{collection}/docs/{name}` | Delete a document. |
| GET | `/collections/{namespace}/{collection}/docs/{name}/versions` | Get all document versions. |
| GET | `/collections/{namespace}/{collection}/docs/{name}/versions/{version}` | Get a specific version of a document. |
| GET | `/collections/{namespace}/{collection}/docs/{name}/indexes/{index}/chunks` | Get document chunks for a given index. |

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/aleph-alpha/refs/heads/main/openapi/aleph-alpha-document-api-openapi.yml
- **Documentation** — https://docs.aleph-alpha.com/phariaai-dev-guide/latest/pharia-openapi/pharia-inference/v4.7.0.html
- **Documentation** — https://docs.aleph-alpha.com/phariaai-dev-guide/latest/responses-api/index.html

## Other Aleph Alpha APIs (12)

- [Aleph Alpha API description API](https://apis.io/apis/aleph-alpha/aleph-alpha-api-description-api/)
- [Aleph Alpha Application Traces API](https://apis.io/apis/aleph-alpha/aleph-alpha-application-traces-api/)
- [Aleph Alpha Benchmark Executions API](https://apis.io/apis/aleph-alpha/aleph-alpha-benchmark-executions-api/)
- [Aleph Alpha Benchmarks API](https://apis.io/apis/aleph-alpha/aleph-alpha-benchmarks-api/)
- [Aleph Alpha Cluster API](https://apis.io/apis/aleph-alpha/aleph-alpha-cluster-api/)
- [Aleph Alpha Collection API](https://apis.io/apis/aleph-alpha/aleph-alpha-collection-api/)
- [Aleph Alpha Connectors API](https://apis.io/apis/aleph-alpha/aleph-alpha-connectors-api/)
- [Aleph Alpha Conversations API](https://apis.io/apis/aleph-alpha/aleph-alpha-conversations-api/)
- [Aleph Alpha Datasets API](https://apis.io/apis/aleph-alpha/aleph-alpha-datasets-api/)
- [Aleph Alpha Downloads API](https://apis.io/apis/aleph-alpha/aleph-alpha-downloads-api/)
- [Aleph Alpha Evaluation Datasets API](https://apis.io/apis/aleph-alpha/aleph-alpha-evaluation-datasets-api/)
- [Aleph Alpha Events API](https://apis.io/apis/aleph-alpha/aleph-alpha-events-api/)

## Tags

Document

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/aleph-alpha/aleph-alpha-document-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/aleph-alpha/.