For AI agents: visit https://docs.cavatica.org/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. 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}
- Get file detailsget
/files/{file_id}/actions/copy
- Copy a file between projectspost
/files/{file_id}/metadata
- Get a file's metadataget
/files/paths
- Get file IDs from file pathspost
/projects/{owner}/{id}/files
- List files (secondary method)get
/storage/exports/{export_id}
- Get details of an export jobget
/storage/volumes/{volume_id}/list
- List the contents of a volumeget
/tasks/{task_id}
- Modify a taskpatch
/v2/action/files/copy
- Copy 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}
- Report uploaded partspost
/v2/upload/multipart/{upload_id}/part
- Report an uploaded partpost
/v2/upload/multipart/{upload_id}/part/{part_number}
- Get upload URL for a file partget
/users
- List user resourcesget
/users/{username}
- Get user infoget
- Disable userdel
/billing
- List billing API pathsget
/billing/groups
- List billing groupsget
/billing/invoices/{invoice_id}
- Get a specific invoiceget
/rate_limit
- Get your current rate limit statusget
/billing/groups/{billing_group}/breakdown/{breakdown_type}
- Get breakdown for a billing groupget
/files
- List files (primary method)get
/projects
- List all your projectsget
- Create a new projectpost
/projects/{owner}
- List projects owned by a particular userget
/projects/{owner}/{project_name}
/projects/{owner}/{project_name}/members
- List members of a projectget
- Add a member to a projectpost
/projects/{owner}/{project_name}/members/{member}
- Get a project member's permissionsget
/projects/{owner}/{project_name}/members/{member}/permissions
- Modify a project member's permissionspatch
- Overwrite a project member's permissionsput

Powered by

Users

The following API call governs user resources:

List user resources

Updated 7 months ago

Get my information

Get controlled study IDs

Did this page help you?

Updated 7 months ago

Get my information

Get controlled study IDs

Did this page help you?