OpenAPI 3.1 Specification

openVIVO API Documentation

Complete API reference for building compliant in-vivo research applications

Version2.0.0
Download OpenAPI JSON

Authentication

The Cloud Vivarium API uses Bearer token authentication. Include your API token in the Authorization header for all requests:

curl -H "Authorization: Bearer your-token-here" \ https://api.cloudvivarium.dev/api/public/v1/studies
Security Note: API tokens provide full access to your account. Keep them secure and never commit them to version control.

Quick Start

Get started with the openVIVO API in minutes. Follow these steps to make your first API call:

1. Get API Access

Contact our team to obtain your API token and base URL.

2. Make Your First Call

Test the API with a simple health check request.

3. Explore Endpoints

Use the interactive playground to test all available endpoints.

Available Endpoints

The openVIVO API provides comprehensive endpoints for managing in-vivo research studies:

GET/api/public/v1/studies

List Studies

Retrieve a list of all available studies with filtering and pagination support.

POST/api/public/v1/studies

Create Study

Create a new research study with protocol validation and compliance checks.

GET/api/public/v1/studies/[id]

Get Study

Retrieve detailed information about a specific study including all associated data.

PUT/api/public/v1/studies/[id]

Update Study

Update study details while maintaining audit trail and compliance requirements.