{
  "opencollection": "1.0.0",
  "info": {
    "name": "Biodock Public Analysis Jobs API",
    "version": "1.0.0-beta"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "X-API-KEY",
      "value": "{{X-API-KEY}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Analysis Jobs",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List analysis jobs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://app.biodock.ai/api/external/analysis-jobs",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of results to show."
              },
              {
                "name": "startingAfter",
                "value": "",
                "type": "query",
                "description": "Pagination cursor id (id of the last item on the previous page)."
              }
            ]
          },
          "docs": "List the progress of all your analysis jobs."
        },
        {
          "info": {
            "name": "Submit analysis job",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://app.biodock.ai/api/external/analysis-jobs",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Submit an analysis job. The files must already be uploaded to the Biodock Filesystem and you must have a published, user-created analysis pipeline. Biodock-authored pipelines are not supported via the API."
        },
        {
          "info": {
            "name": "Fetch analysis job",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://app.biodock.ai/api/external/analysis-jobs/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "View the progress and results of a specific analysis job."
        },
        {
          "info": {
            "name": "Fetch download masks job",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://app.biodock.ai/api/external/analysis-jobs/:id/download-masks",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "View the progress of masks generation and, once complete, obtain the masks download link."
        },
        {
          "info": {
            "name": "Submit download masks job",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://app.biodock.ai/api/external/analysis-jobs/:id/download-masks",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Generate the masks data for an analysis job. Masks data is not generated by default during an analysis job."
        }
      ]
    }
  ],
  "bundled": true
}