{
  "opencollection": "1.0.0",
  "info": {
    "name": "Code Ocean Capsules Computations API",
    "version": "v1"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Computations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Run a capsule or pipeline",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://codeocean.com/api/v1/computations",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Runs a Capsule or Pipeline, optionally attaching data assets and passing parameters. Returns the created Computation object. May return 429 when the Computation API is overloaded — back off before retrying."
        },
        {
          "info": {
            "name": "Get computation",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://codeocean.com/api/v1/computations/:computation_id",
            "params": [
              {
                "name": "computation_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the computation."
              }
            ]
          },
          "docs": "Retrieves information from a computational run."
        },
        {
          "info": {
            "name": "Rename computation",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://codeocean.com/api/v1/computations/:computation_id",
            "params": [
              {
                "name": "computation_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the computation."
              },
              {
                "name": "name",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Renames an existing computational run."
        },
        {
          "info": {
            "name": "Delete computation",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://codeocean.com/api/v1/computations/:computation_id",
            "params": [
              {
                "name": "computation_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the computation."
              }
            ]
          },
          "docs": "Deletes a computational run, stopping it first if it is running."
        },
        {
          "info": {
            "name": "List computation result files",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://codeocean.com/api/v1/computations/:computation_id/results",
            "params": [
              {
                "name": "computation_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the computation."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Lists the result files generated by a computation. An empty path returns the /results root."
        },
        {
          "info": {
            "name": "Get result file URLs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://codeocean.com/api/v1/computations/:computation_id/results/urls",
            "params": [
              {
                "name": "computation_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the computation."
              },
              {
                "name": "path",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Generates signed download and view URLs for a computation result file."
        }
      ]
    }
  ],
  "bundled": true
}