For AI agents: the docs index is at https://docs.cavatica.org/llms.txt. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Seven Bridges knowledge center Documentation

Home Guides API Reference Release notes

v1.0

Seven Bridges knowledge center Documentation

API Reference

v1.0Home Guides API Reference Release notes

CAVATICA API

API overview
API client library
Rate limit
User
Get my informationget
Users
- Get controlled study IDs
Billing
Get analysis breakdown for a billing group
Get storage breakdown for a billing group
Get egress breakdown for a billing group
Projects
Files, folders and metadata
Upload files
Apps
Tasks
Volumes
API status codes

FOLDERS API

Folders Overview

BULK API ACTIONS

Bulk features overview

ASYNC BULK ACTIONS

Overview
Copy multiple files
Delete multiple files and folders
Get details of a copy job
Get details of a deletion job
Get details of all async jobs
Get details of a move job
Move multiple files or folder

DRS API

Overview
Get info about a DRS object
Get an URL for downloading a file
Download a DRS object (file) tutorial
Start a bulk DRS import job
Get details of a bulk DRS import job

FHIR API

Overview
Start a bulk FHIR import job
Get details of a bulk FHIR import job

WES API

Overview
Run a workflow
Cancel a running workflow
Get the status of the workflow run
Get details of a workflow run
List workflow runs
Get service information

CAVATICA DATASETS API (Advanced Access)

Cavatica Datasets API Overview

api-settings

/
/billing/invoices
- List invoicesget
/user
/billing/groups/{billing_group}
- Get a single billing groupget
/bulk/storage/exports/create
- Start a bulk export jobpost
/files/{file_id}
/files/{file_id}/actions/copy
- Copy a file between projectspost
/files/{file_id}/metadata
/files/paths
- Get file IDs from file pathspost
/projects/{owner}/{id}/files
- Get the list of files in a projectget
/storage/exports/{export_id}
- Get details of an export jobget
/storage/volumes/{volume_id}/list
- List the contents of a volumeget
/tasks/{task_id}
/v2/action/files/copy
- Copy multiple files between projectspost
/v2/storage/volumes/{volume_id}/{object_id}
- Get details of a file within a volumeget
/v2/tasks
- Create a new draft taskpost
- List tasks you can accessget
/v2/upload/multipart/{upload_id}
/v2/upload/multipart/{upload_id}/part
- Report an uploaded file partpost
/v2/upload/multipart/{upload_id}/part/{part_number}
- Get the upload URL for a file partget
/billing
- List billing API pathsget
/billing/groups
- List billing groupsget
/billing/invoices/{invoice_id}
- Get a specific invoiceget
/billing/groups/{billing_group}/breakdown/{breakdown_type}
- Get breakdown for a billing groupget
/files
- Create a folderpost
/bulk/drs/imports/{bulk_import_id}
- Get details of a bulk DRS import jobget
/bulk/drs/imports/create
- Start a bulk DRS import jobpost
/files/{file_id}/actions/move
- Move a file between folderspost
/files/{file_id}/download_info
- Get download information and URL for a fileget
/files/{file_id}/list
- List folder contentsget
/storage/volumes/{volume_id}/members
/v2/upload/multipart
- List current multipart uploadsget
- Initialize a multipart uploadpost
/v2/upload/multipart/{upload_id}/complete
- Finalize a multipart uploadpost
/v2/apps
- List all apps available to youget
/v2/apps/{owner}/{project_name}/{app}
- Get details of an appget
/v2/apps/{owner}/{project_name}/{app}/actions/copy
- Copy an apppost
/v2/apps/{owner}/{project_name}/{app}/raw
- Get raw CWL for an appget
- Add an app using raw CWLpost
/v2/apps/{owner}/{project_name}/{app}/{revision}
- Get details of an app revisionget
/v2/apps/{owner}/{project_name}/{app}/{revision}/raw
- Get raw CWL for an app revisionget
- Add an app using raw CWLpost
/projects/{owner}/{project_name}/tasks
- List tasks in a projectget
/tasks/{task_id}/actions/abort
- Abort a taskpost
/tasks/{task_id}/actions/run
- Perform an action on a specific taskpost
/tasks/{task_id}/execution_details
- Get task execution detailsget
/tasks/{task_id}/inputs
- Get task inputsget
- Modify task inputspatch

Powered by

Users

The following API call governs user resources:

List user resources

Updated 9 months ago

Get my information

Get controlled study IDs

Did this page help you?

Updated 9 months ago

Get my information

Get controlled study IDs

Did this page help you?