# Deepset Indexes API

**Canonical:** https://apis.io/apis/deepset/deepset-indexes-api/  
**Provider:** Deepset — https://apis.io/providers/deepset/  
**Base URL:** https://api.cloud.deepset.ai  
**Documentation:** https://docs.cloud.deepset.ai/openapi.yaml

Deepset Indexes API is one of 32 APIs that [Deepset](https://apis.io/providers/deepset/) publishes on the [APIs.io](https://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.

The indexes API from Deepset — 12 operation(s) for indexes.

## Operations (16)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/v1/workspaces/{workspace_name}/indexes` | Get Indexes |
| POST | `/api/v1/workspaces/{workspace_name}/indexes` | Create Index |
| DELETE | `/api/v1/workspaces/{workspace_name}/indexes/{index_name}` | Delete Index |
| GET | `/api/v1/workspaces/{workspace_name}/indexes/{index_name}` | Get Index By Name |
| PATCH | `/api/v1/workspaces/{workspace_name}/indexes/{index_name}` | Update Index |
| POST | `/api/v1/workspaces/{workspace_name}/indexes/{index_name}/deploy` | Deploy Index |
| GET | `/api/v1/workspaces/{workspace_name}/indexes/{index_name}/documents-count` | Count Documents |
| POST | `/api/v1/workspaces/{workspace_name}/indexes/{index_name}/documents-query` | Query Documents |
| POST | `/api/v1/workspaces/{workspace_name}/indexes/{index_name}/documents-stream` | Get All Documents Stream |
| GET | `/api/v1/workspaces/{workspace_name}/indexes/{index_name}/documents/{document_id}` | Get Document |
| GET | `/api/v1/workspaces/{workspace_name}/indexes/{index_name}/files` | Get Indexed Files By Status |
| POST | `/api/v1/workspaces/{workspace_name}/indexes/{index_name}/files/{file_id}/reindex` | Schedule Single File For Indexing |
| GET | `/api/v1/workspaces/{workspace_name}/indexes/{index_name}/logs` | Get Pipeline Index Logs |
| POST | `/api/v1/workspaces/{workspace_name}/indexes/{index_name}/undeploy` | Undeploy Index |
| GET | `/api/v1/workspaces/{workspace_name}/indexes/{index_name}/visualization` | Get Pipeline Visualization |
| PUT | `/api/v1/workspaces/{workspace_name}/indexes/{index_name}/visualization` | Update Pipeline Visualization |

## Machine-readable artifacts (1)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/deepset/refs/heads/main/openapi/deepset-indexes-api-openapi.yml

## Other Deepset APIs (12)

- [Deepset API Token API](https://apis.io/apis/deepset/deepset-api-token-api/)
- [Deepset Custom Components API](https://apis.io/apis/deepset/deepset-custom-components-api/)
- [Deepset Datasets API](https://apis.io/apis/deepset/deepset-datasets-api/)
- [Deepset Debug Tunnel API](https://apis.io/apis/deepset/deepset-debug-tunnel-api/)
- [Deepset Deployments API](https://apis.io/apis/deepset/deepset-deployments-api/)
- [Deepset Feedback API](https://apis.io/apis/deepset/deepset-feedback-api/)
- [Deepset Feedback Tags API](https://apis.io/apis/deepset/deepset-feedback-tags-api/)
- [Deepset File API](https://apis.io/apis/deepset/deepset-file-api/)
- [Deepset Haystack API](https://apis.io/apis/deepset/deepset-haystack-api/)
- [Deepset Health API](https://apis.io/apis/deepset/deepset-health-api/)
- [Deepset Infrastructure API](https://apis.io/apis/deepset/deepset-infrastructure-api/)
- [Deepset Jobs API](https://apis.io/apis/deepset/deepset-jobs-api/)

## Tags

Index

---

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