Step 1: Set up your workspace

This tutorial will walk you through the steps to set up your workspace so that you’ll be able to write and publish your own Workflows.

To simplify the setup process for this tutorial, you’ll write and deploy your Workflows using Codespaces, a cloud-based development environment hosted by GitHub that we’ve pre-configured to include the Artificial SDK.

Create a GitHub account

1. Create a GitHub account associated with your company email.

2. Optional: To promote standardization and collaboration in the lab automation community, Workflows is a community platform. However, we understand that some users prefer to maintain anonymity and privacy. In these cases, you can opt out of being publicly listed on shared community Artificial repos.

   To do this, in GitHub, turn off Settings ‣ Notifications ‣ Automatically watch repositories.

   Note

   Repositories with your workflows are private and not public to the community.

3. Provide your GitHub User ID to your Customer Success Manager.

Create a Codespace

1. Open the link to your GitHub Repo from your Customer Success Manager.

2. Create a branch for your work so it doesn’t conflict with anybody else’s. For example: “name/tutorial”.

3. Click the green button labeled <> Code and then the green button labeled Create codespace on name/tutorial. This step may take a few minutes to complete.

Connect your Codespace to Artificial

1. Create a new file configs/dev/secrets.yaml containing:

   artificial:
     token: art_token
   

2. Create an Artificial API Key for your Artificial instance.

   1. Go to your Artificial instance (likely “company-dev.artificial.com”).

   2. Go to Settings and select API Key under your name.

   3. Select Add new Token and name it “Codespaces”.

   4. Copy the token.

   5. Paste the token into the secrets.yaml file, replacing art_token.

3. Confirm your connection by clicking on the Artificial logo on the left pane. If you successfully connected to the instance, you can see Assistants listed.