Using Secrets and API Keys

Add Secret Key Input Parameter

• Navigate to the Node Editor for a logic node where you intend to use a secret key.

• In the Params section, add a new input parameter to receive the Secret Key.

• For example, let's say you want to use the Replicate API Key. Create an input parameter as follows:

  [
    {
      key: 'apiKey',
      label: 'Replicate API Key',
      description: 'The API Key for Replicate',
      required: false,
      validation: '',
      type: 'string',
    },
  ];

  or via UI Form:

  

• Save the input parameter.

Access Secret Key in Node Logic

• Within the Node Editor, navigate to the Node Logic section.

• Import the input parameters into your function, for example:

  export default async function runMusicGenModel({ prompt, apiKey }) {
    // Your code here
  }

• Use the apiKey variable to access the API Key value in your logic:

  const replicate = new Replicate({
    auth: apiKey,
  });
  

• Save your changes.

Add Secret in BuildShip Secret Manager

• Back to your workflow workspace, click on the Expression Icon </> corresponding to the API Key input in your Logic Node.
• Under "Secrets," click on "Add a Secret". This action opens the BuildShip Secret Manager.
• Inside the BuildShip Secret Manager, you have the ability to add, modify, or delete secret keys.
• Click "Add a Secret Key", then provide the "Secret Name" and "Secret Value" associated with your API Key.
• Click "Save" to add the secret key to the BuildShip Secret Manager.

Select Secret Key in Node Editor

• Back in the Node Editor, within the Secrets section, click "Refresh."
• Select the Secret Key you added from the dropdown menu.