Prerequisites

Generated with Capsule Scope
The Computation ID

The Computation ID can only be accessed from the Computation Object.

A typical use case is to use

Both methods will have the Computation ID in the Response that can be used in Computations API for further tracking and getting results.

id
- string
  - the Computational id
created
- float64
  - Computation create time
name
- string
  - the display name of the Computation
run_time
- integer
  - the total run time in seconds
cloud_workstation
- boolean
  - indicates whether this Computation is a cloud workstation
parameters
- Optional - array
  - run parameters
    name - string
    parameter name
    value - string
    parameter value
has_results
- boolean
  - indicates whether the Computation has results
state
- string
  - initializing, running, finalizing, completed
end_status
- stopped, failed, succeeded
data_assets
- Optional - array
  - attached Data Assets
    id - string
    attached Data Asset ID
    mount - string
    attached Data Asset mount
- processes
  - Optional - array
    Pipeline processes information.
    name
    Pipeline process name.
    capsule_id
    string
    the id of the Capsule executed in this process.
    version
    Optional - integer
    Capsule version in case its a release.
    public
    Optional - boolean
    indicates the Capsule is a public Code Ocean App.
    parameters
    Optional - array
    run parameters
    name - string
    the parameter title
    param_name - string
    parameter name
    value - string
    parameter value

Get Computation

GEThttps://{domain}/api/v1/computations/{computations_id}

This API allows for the retrieval of information from a computational run.

Path Parameters

Name

Type

Description

GET*

/computations/:computation_id

Headers

Name

Type

Description

-u*

Authorize with Code Ocean API Secret: -u $API_SECRET :

This is setting the "Authorization Basic" base64string header

-H*

Set this to: Content - Type: application/json

Request Body

Name

Type

Description

computational_id*

string

Identification of computational run

Request Example Bash

curl --location --request GET 'https://codeocean.com/api/v1/computations/c229ed13-ec06-43d0-abd9-4d481af3f5e3' \--header 'Content-Type: application/json' \-u \'${API_SECRET}:\' \

Request Example Python

import os, requests headers = { "Content-Type": "application/json"}response=requests.get('https://codeocean.com/api/v1/computations/c229ed13-ec06-43d0-abd9-4d481af3f5e3', headers=headers, auth=("'" + os.getenv('API_SECRET', ''), "'"), )

Response

List Files Computation URL

GEThttps://{domain}/api/v1/computations/{computations_id}

This API allows for the generation of a URL to download a file from a Computation.

Path Parameters

Name

Type

Description

GET*

/computations/:computation_id

Headers

Name

Type

Description

-u*

authorize with Code Ocean API Secret:

-u $API_SECRET:

This is setting the "Authorization

Basic" base64string header

-H*

Set this to: Content - Type: application/json

Request Body

Name

Type

Description

computational_id*

string

identification of the computational run

Request Example Bash

curl --location --request GET 'https://codeocean.com/api/v1/computations/9390055d-7884-4997-8dfc-88bf7445b617/results/download_url?path=GSM12345_R1_fastqc.html' \--header 'Content-Type: application/json' \-u \'${API_SECRET}:\'

Request Example Python

import os, requests headers = { "Content-Type": "application/json"} response=requests.get('https://codeocean.com/api/v1/computations/9390055d-7884-4997-8dfc-88bf7445b617/results/download_url?path=GSM12345_R1_fastqc.html', headers=headers, auth=("'" + os.getenv('API_SECRET', ''), "'"), )

Response

{ "url":"https://domain-s3resultsbucket/link/to/file"}

Run Computation

POSThttps://{domain}/api/v1/computations

This API allows for the running of Capsules/Pipelines with Data Assets.

Prerequisite

Before using this API call, you may need AWS Cloud Credentials configured as Secrets or an Assumable Role, if you are using Data Assets from Cloud Resources.

Path Parameters

Name

Type

Description

POST*

/computations/

Headers

Name

Type

Description

-u:*

Authorize with Code Ocean API Secret: -u $API_SECRET :

-H:*

Set this to: Content - Type: application/json

--data-raw:*

JSON with parameters

Request Body

Name

Type

Description

capsule_id*

string

identification of the capsule if both capsule_id and pipeline_id are used, only the capsule id will be used

pipeline_id

string

identification of the pipeline

data_assets*

array

ID*

string

identification of the data asset to be used in the computational run

Mount

string

name of the folder to mount the dataset into position

Run Capsule

Request Example Bash

curl --location --request POST 'https://codeocean.com/api/v1/computations' \--header 'Content-Type: application/json' \-u \'${API_SECRET}:\' \--data-raw '{"capsule_id": "4bc97533-6eb4-48ac-966f-648548a756d2"}'

Request Example Python

import os, requests headers = { "Content-Type": "application/json"}json_data = { "capsule_id": "4bc97533-6eb4-48ac-966f-648548a756d2"} response = requests.post( 'https://codeocean.com/api/v1/computations', headers=headers, json=json_data, auth=("'" + os.getenv('API_SECRET', ''), "'"), )

Run Pipeline

Request Example Bash

curl --location --request POST 'https://codeocean.com/api/v1/computations' \--header 'Content-Type: application/json' \-u \'${API_SECRET}:\' \--data-raw '{"pipeline_id": "4bc97533-6eb4-48ac-966f-648548a756d2"}'

Request Example Python

import os, requests headers = { "Content-Type": "application/json"}json_data = { "pipeline_id": "4bc97533-6eb4-48ac-966f-648548a756d2"} response = requests.put('https://codeocean.com/api/v1/data_assets/d36665a7-ef59-4b8e-a799-bee7f83ee317', headers=headers, json=json_data, auth=("'" + os.getenv('API_SECRET', ''), "'"), )

Response