# Aignostics Platform API

**Canonical:** https://apis.io/apis/aignostics/aignostics-platform-api/  
**Provider:** Aignostics — https://apis.io/providers/aignostics/  
**Base URL:** https://platform.aignostics.com/api/v1  
**Documentation:** https://aignostics.readthedocs.io/en/latest/get_started_api.html

Aignostics Platform API is published by [Aignostics](https://apis.io/providers/aignostics/) on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Digital Pathology, Whole Slide Imaging, Machine-Learning, and Health. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

The public REST API of the Aignostics Platform. Lists the computational pathology applications and application versions an organization is entitled to, submits whole slide images as processing runs, tracks run and per-item state, retrieves result artifacts through short-lived presigned storage URLs, manages run and item custom metadata with optional checksum preconditions, and shares runs through access grants and single-use share tokens. OpenAPI 3.1.0, 26 operations, OAuth 2.0 authorization-code and device-code flows against the organization's Auth0 tenant.

## Operations (26)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1/applications` | List available applications |
| GET | `/v1/applications/{application_id}` | Read Application By Id |
| GET | `/v1/applications/{application_id}/versions/{version}` | Application Version Details |
| GET | `/v1/runs` | List Runs |
| POST | `/v1/runs` | Initiate Run |
| GET | `/v1/runs/{run_id}` | Get run details |
| POST | `/v1/runs/{run_id}/cancel` | Cancel Run |
| GET | `/v1/runs/{run_id}/items` | List Run Items |
| GET | `/v1/runs/{run_id}/items/{external_id}` | Get Item By Run |
| GET | `/v1/runs/{run_id}/artifacts/{artifact_id}/file` | Get Artifact Url |
| DELETE | `/v1/runs/{run_id}/artifacts` | Delete Run Items |
| PUT | `/v1/runs/{run_id}/custom-metadata` | Put Run Custom Metadata |
| PUT | `/v1/runs/{run_id}/items/{external_id}/custom-metadata` | Put Item Custom Metadata By Run |
| GET | `/v1/me` | Get current user |
| GET | `/v1/applications/{application_id}/versions/{version}/documents` | List version documents |
| GET | `/v1/applications/{application_id}/versions/{version}/documents/{name}` | Get version document metadata |
| GET | `/v1/applications/{application_id}/versions/{version}/documents/{name}/file` | Download version document (browser) |
| GET | `/v1/applications/{application_id}/versions/{version}/documents/{name}/content` | Stream version document content (programmatic) |
| POST | `/v1/access/grants` | Create Grant |
| GET | `/v1/access/grants` | List Grants |
| GET | `/v1/access/grants/{grant_id}` | Get Grant |
| DELETE | `/v1/access/grants/{grant_id}` | Revoke Grant |
| POST | `/v1/access/share-tokens` | Create Share Token |
| GET | `/v1/access/share-tokens` | List Share Tokens |
| GET | `/v1/access/share-tokens/{share_token_id}` | Get Share Token |
| DELETE | `/v1/access/share-tokens/{share_token_id}` | Revoke Share Token |

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/aignostics/refs/heads/main/openapi/aignostics-platform-api-openapi.json
- **Documentation** — https://aignostics.readthedocs.io/en/latest/get_started_api.html
- **APIReference** — https://aignostics.readthedocs.io/en/latest/api_explorer_v1.html
- **Console** — https://platform.aignostics.com/explore-api
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/aignostics/refs/heads/main/apis.yml

## Tags

Digital Pathology, Whole Slide Imaging, Machine-Learning, Health

---

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