Skip to content
CardioAISupport Center

Overview

Cardio.AI REST API v3 3.0

Section titled “Cardio.AI REST API v3 3.0”

Every error response, including router-level 404 (unknown path) and 405 (unsupported method), carries the JSON Error object with a human-readable message and a stable machine-readable reason code.

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
GET
/v3/downloads/{download_id}/chunks/{chunk_index}
POST
/v3/uploads
POST
/v3/uploads/{upload_id}/chunks
POST
/v3/orgs/{organization_path}/tasks
GET
/v3/orgs/{organization_path}/tasks/{task_id}/report
GET
/v3/orgs/{organization_path}/tasks/{task_id}/status
POST
/v3/streams/find
POST
/v3/streams/start
POST
/v3/streams/{stream_id}/finish
POST
/v3/streams/{stream_id}/frames
GET
/v3/streams/{stream_id}/params
POST
/v3/streams/{stream_id}/params

Authentication

Section titled “Authentication”

ApiToken

Section titled “ApiToken”

API token for authentication and authorization. Obtain this token from your user settings dialog and include it in the X-Api-Token header.

Security scheme type: apiKey

Header parameter name: X-Api-Token