Sharing and Security
      Back to home
      1. Pluto Knowledge Base
      2. Sharing and Security

      Creating your API token

      Table of contents Accessing Pluto data programmatically Use the Pluto API to fetch data from your projects and experiments, and integrate Pluto with your own scripts and apps
      Written by Daniel Shin
      Updated over a week agoDaniel Shin Table of contents

      To perform your own custom analysis on data stored in Pluto, or to integrate Pluto data into your own apps or scripts, you can use the Pluto API token to fetch data programmatically.

      To fetch data, you'll typically need 3 pieces of information:

      1. Pluto API token

      2. Pluto experiment ID (e.g. PLX000327)

      3. Plot ID (if fetching results produced from a specific analysis)

      Pluto API token

      Pluto experiment ID (e.g. PLX000327)

      Plot ID (if fetching results produced from a specific analysis)

      If you are accessing data programmatically for the first time, you'll need to generate a new API token. Navigate to your Account page and click the "+ API token" button.

      A new API token will be generated, and can then be copied or viewed.

      This API token can be used to fetch data programmatically using a curl request or Pluto's R package.

      R package

      1. Set the PLUTO_API_TOKEN environment variable

      Copy the API token that you created on your Account page and store it in an environment variable called PLUTO_API_TOKEN. To do this, create a .Renviron file containing:

      2. Source the latest version of the R package

      3. Fetch sample data for an experiment

      4. Fetch assay data for an experiment

      5. Fetch the results table for a specific experiment & analysis

      Obtain the plot ID from the Methods Modal on any plot:

      Use the plot ID in the pluto_read() function to fetch the underlying results:

      Python example

      CURL requests

      CURL requests must provide your PLUTO_API_TOKEN and experiment_id and data_type ("sample", "assay", or "results").

      Deleting your API token

      You can delete your API token by clicking the "Delete token" button. Caution: deleting your API token will immediately remove any access associated with that token. This means that any apps or scripts that were using this token will no longer be able to fetch data.

      Did this answer your question?😞😐😃