How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Code Ocean Capsules API

Reproducible compute capsules and pipelines

Code Ocean Capsules API is one of 3 APIs that Code Ocean publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Capsules. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 10 operations across 8 paths, and defines 5 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against 2 base URLs: https://codeocean.com/api/v1, https://{domain}/api/v1.

10 operations 8 paths 5 schemas 2 DELETE3 GET1 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://codeocean.com/api/v1
Authentication
HTTP Basic
Contact
License
Proprietary
Resource Areas
1

Authentication & Security 1

Code Ocean Capsules API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (accessToken). By default, every request must be authenticated.

  • accessToken — HTTP Basic authentication. Provide your Code Ocean access token (prefix cop) as the basic-auth username with an empty password, e.g. -u "copxxxxxxxxxx:".

Paths & Operations 10

Across 8 paths, the API surfaces 10 operations — 2 DELETE, 3 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Capsules 10

Reproducible compute capsules and pipelines

GET
/capsules/{capsule_id}
Get capsule
getCapsule 1 param → 200401403404
DELETE
/capsules/{capsule_id}
Delete capsule
deleteCapsule 1 param → 204401403404
GET
/capsules/{capsule_id}/app_panel
Get capsule app panel
getCapsuleAppPanel 2 params → 200401404
GET
/capsules/{capsule_id}/computations
List capsule computations
listCapsuleComputations 1 param → 200401404
POST
/capsules/{capsule_id}/data_assets
Attach data assets to a capsule
attachDataAssets 1 param body → 200401403
DELETE
/capsules/{capsule_id}/data_assets
Detach data assets from a capsule
detachDataAssets 1 param body → 204401403
PATCH
/capsules/{capsule_id}/archive
Archive or unarchive a capsule
archiveCapsule 1 param body → 204401403
POST
/capsules/{capsule_id}/sync
Git sync a capsule
syncCapsuleGit 1 param → 200401403
POST
/capsules/search
Search capsules
searchCapsules body → 200401
POST
/pipelines/search
Search pipelines
searchPipelines body → 200401

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are SearchParams (13 properties), Computation (11 properties), Capsule (9 properties), SearchResults (3 properties). Each schema is shown below with its type and property counts.

Error
object
1 property
SearchParams
object
Search request with filtering, sorting and cursor pagination.
13 properties
SearchResults
object
Cursor-paginated search results.
3 properties
Capsule
object
A reproducible compute capsule or pipeline.
9 properties
Computation
object
A run of a capsule or pipeline.
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

code-ocean-capsules-api-openapi.yml Raw ↑

Other APIs Code Ocean publishes across the network.

Code Ocean Computations API
Code Ocean Data Assets API
Where this information came from

This is an independent, third-party profile of Code Ocean Capsules API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.