Managing API Credentials

This guide explains how to create, manage, and use API Credentials within the Bourne AI console. Credentials allow your agents to securely authenticate with external services when using integrated tools like Gmail, Outlook, YouTube, Instagram, and more.

Why Use Credentials?

Instead of embedding sensitive API keys or tokens directly into your agent instructions (which is insecure and difficult to manage), you can store them securely as Credentials. When an agent needs to make an authenticated API call, you simply assign the appropriate credential to it.

This approach offers:

  • Security: Sensitive keys are stored securely and not exposed in agent configurations.
  • Reusability: The same credential can be used by multiple agents across different workflows.
  • Manageability: Update an API key in one place (the credential), and all agents using it will automatically use the updated key.

Accessing the Credentials Section

  1. Navigate to Settings: From the main dashboard or side menu, go to the "Settings" section.
  2. Select Credentials: Within the Settings options, click on "API Credentials".

This will display a list of your existing credentials.

Creating a New Credential

You can create credentials using either the intuitive Wizard Mode or the flexible Manual Mode.

  1. Click "Add Credential": On the API Credentials list page, click the "Add Credential" button

The Wizard mode simplifies the setup process, especially for common services that use OAuth2.

  1. Select Service Template (Optional): If you are connecting to a supported service (like Google, Slack, Microsoft, etc.), you can select its template. This pre-fills certain OAuth2 details like Authorization URL, Token URL, and common Scopes, saving you time. If your service isn't listed, you can still use the Wizard by selecting "Other" or proceed with Manual Mode.
  2. Enter Basic Details:
    • Title: Give your credential a descriptive name (e.g., "My Google Calendar Access").
    • Authentication Type: The Wizard primarily focuses on OAuth2 (Authorization Code) when using templates, but also supports other types if "Other" is selected.
  3. Fill in Required Fields: Based on the template or your selection, the Wizard will guide you through entering necessary details:
    • For OAuth2: Client ID, Client Secret, and Scopes (adjust pre-filled scopes if needed).
    • For other types (if 'Other' selected): Follow prompts for API Key, Bearer Token, or Basic Auth details (see Manual Mode section below for field descriptions).
  4. Save and Connect (OAuth2):
    • Click "Save Credential".
    • You will see a "Connect" button. Clicking this redirects you to the provider's authorization page.
    • Authorize the connection. You'll be redirected back, and Bourne automatically handles the token exchange (Access and Refresh tokens) and secure storage. Bourne also manages token refreshes automatically.
  5. Save (Other Types): Click "Save Credential".

Manual Mode

Manual mode gives you full control over all authentication parameters, suitable for services not covered by Wizard templates or when you need specific configurations.

  1. Choose Manual Mode: Select this option after clicking "Add Credential".
  2. Fill in the Details:
    • Title: Give your credential a descriptive name.
    • Authentication Type: Select the exact type the API uses:
      • Bearer Token:
        • Bearer Token Field: Paste your token.
      • API Key:
        • API Key Field: Paste your key.
        • Header Name: Specify the HTTP header name (e.g., X-API-Key).
        • Add to: Choose Headers or Query Params.
      • Basic Authentication:
        • Username: Enter the username.
        • Password: Enter the password.
      • OAuth2 (Authorization Code):
        • Authorization URL: The provider's URL for user authorization.
        • Token URL: The provider's URL for exchanging the code for tokens.
        • Client ID: Your application's client ID from the provider.
        • Client Secret: Your application's client secret from the provider.
        • Scopes: The permissions your application requires, separated by spaces or commas as per the provider's documentation.
  3. Save the Credential: Click "Save Credential".
  4. Connect (OAuth2): If you configured OAuth2, a "Connect" button will appear after saving. Follow the same connection process described in the Wizard Mode (Step 4) to authorize and enable automatic token management.

Service-Specific Setup Guides

The following guides show you how to set up credentials for specific services using the Bourne AI console UI. All OAuth2 services follow the same general pattern: select the service template, enter your Client ID and Client Secret, save, and connect.

Gmail

Tools Enabled: Manage Gmail email (list, read, send, search, mark as read)

UI Steps:

  1. Go to Settings → API Credentials → Add Credential
  2. Choose Wizard Mode
  3. In the platform search field, type "Gmail" and select it from the dropdown
  4. The form will auto-populate with:
    • Auth Type: OAuth2
    • Scopes: gmail.readonly gmail.send gmail.modify (pre-filled, can be adjusted)
  5. Enter your Client ID and Client Secret (obtained from Google Cloud Console)
  6. Click Save Credential
  7. Click Connect to authorize through Google's OAuth flow
  8. Once connected, the credential will show as "Connected" with a green indicator

What Agents Can Do: Send emails, read inbox, search messages, manage labels, mark as read/unread

Outlook Email

Tools Enabled: Manage Outlook/Microsoft 365 email

UI Steps:

  1. Go to Settings → API Credentials → Add Credential
  2. Choose Wizard Mode
  3. Search for "Outlook" and select Outlook Email from the dropdown
  4. The form will auto-populate with:
    • Auth Type: OAuth2
    • Scopes: Mail.ReadWrite Mail.Send (pre-filled)
  5. Enter your Client ID and Client Secret (from Azure AD App Registration)
  6. Click Save Credential
  7. Click Connect to authorize through Microsoft's OAuth flow
  8. Connection status will update to "Connected"

What Agents Can Do: Send emails, read messages, manage folders, search inbox

YouTube

Tools Enabled: Get comments, post replies, get channel info, search videos, upload videos

UI Steps:

  1. Go to Settings → API Credentials → Add Credential
  2. Choose Wizard Mode
  3. Search for "YouTube" and select it from the dropdown
  4. The form will auto-populate with:
    • Auth Type: OAuth2
    • Scopes: youtube.force-ssl (pre-filled)
  5. Enter your Client ID and Client Secret (from Google Cloud Console with YouTube Data API enabled)
  6. Click Save Credential
  7. Click Connect to authorize
  8. Verify connection status shows "Connected"

What Agents Can Do: Fetch video comments, reply to comments, get channel statistics, search for videos, upload new videos

Instagram

Tools Enabled: 13 Instagram Business tools including content publishing, comment moderation, insights

UI Steps:

  1. Go to Settings → API Credentials → Add Credential
  2. Choose Wizard Mode
  3. Search for "Instagram" and select it from the dropdown
  4. The form will auto-populate with:
    • Auth Type: OAuth2
    • Scopes: instagram_business_basic instagram_business_manage_messages instagram_business_manage_comments instagram_business_content_publish instagram_business_manage_insights (pre-filled)
  5. Enter your Client ID and Client Secret (from Meta for Developers)
  6. Click Save Credential
  7. Click Connect to authorize through Instagram/Facebook OAuth
  8. Connection confirmed with green "Connected" status

What Agents Can Do: Get account info, retrieve media, publish posts, moderate comments, send private replies, view insights

LinkedIn

Tools Enabled: Post to LinkedIn, get profile information

UI Steps:

  1. Go to Settings → API Credentials → Add Credential
  2. Choose Wizard Mode
  3. Search for "LinkedIn" and select it
  4. The form will auto-populate with:
    • Auth Type: OAuth2
    • Scopes: openid profile w_member_social (pre-filled)
  5. Enter your Client ID and Client Secret (from LinkedIn Developer Portal)
  6. Click Save Credential
  7. Click Connect to authorize
  8. Verify "Connected" status

What Agents Can Do: Post text updates, share images/videos, retrieve user profile data

Google Meet

Tools Enabled: Create and manage Google Meet meetings

UI Steps:

  1. Go to Settings → API Credentials → Add Credential
  2. Choose Wizard Mode
  3. Search for "Google Meet" and select it
  4. The form will auto-populate with:
    • Auth Type: OAuth2
    • Scopes: calendar calendar.events (pre-filled - Google Meet requires Calendar API)
  5. Enter your Client ID and Client Secret (from Google Cloud Console)
  6. Click Save Credential
  7. Click Connect to authorize
  8. Connection status will show "Connected"

What Agents Can Do: Schedule meetings, create instant meetings, manage meeting settings

Google Docs

Tools Enabled: Create, edit, read, list Google documents

UI Steps:

  1. Go to Settings → API Credentials → Add Credential
  2. Choose Wizard Mode
  3. Search for "Google Docs" and select it
  4. The form will auto-populate with:
    • Auth Type: OAuth2
    • Scopes: documents drive (pre-filled)
  5. Enter your Client ID and Client Secret (from Google Cloud Console)
  6. Click Save Credential
  7. Click Connect to authorize
  8. Verify connection shows "Connected"

What Agents Can Do: Create new documents, edit existing docs with markdown, read document content, list user's documents

Canva

Tools Enabled: 9 Canva tools for design creation and management

UI Steps:

  1. Go to Settings → API Credentials → Add Credential
  2. Choose Wizard Mode
  3. Search for "Canva" and select it
  4. The form will auto-populate with:
    • Auth Type: OAuth2
    • Scopes: asset:read asset:write brandtemplate:content:read brandtemplate:meta:read design:content:read design:content:write design:meta:read profile:read (pre-filled)
  5. Enter your Client ID and Client Secret (from Canva Developers)
  6. Click Save Credential
  7. Click Connect to authorize
  8. Connection confirmed with "Connected" status

What Agents Can Do: Create designs, upload assets, use brand templates, export designs, manage design content

Zoom (API Key Method)

Tools Enabled: Manage Zoom meetings

UI Steps:

  1. Go to Settings → API Credentials → Add Credential
  2. Choose Wizard Mode
  3. Search for "Zoom" and select it
  4. The form will show:
    • Auth Type: API Key (Server-to-Server OAuth)
  5. Enter:
    • API Key (or Client ID): Your Zoom Server-to-Server OAuth Client ID
    • API Secret (or Client Secret): Your Zoom Client Secret
    • Account ID: Your Zoom Account ID
  6. Click Save Credential
  7. No separate "Connect" step required - credentials are validated on first use

What Agents Can Do: Create meetings, list meetings, get meeting details, manage Zoom account settings

Twilio (API Key Method)

Tools Enabled: Send SMS, make voice calls, manage Twilio resources

UI Steps:

  1. Go to Settings → API Credentials → Add Credential
  2. Choose Wizard Mode
  3. Search for "Twilio" and select it
  4. The form will show:
    • Auth Type: API Key
  5. Enter:
    • Account SID: Your Twilio Account SID
    • Auth Token (or API Key): Your Twilio Auth Token or API Key
  6. Click Save Credential
  7. No OAuth flow required - credentials saved directly

What Agents Can Do: Send SMS messages, make phone calls, retrieve message history, manage phone numbers

Browser Automation (Steel.dev)

Tools Enabled: Automated web browser interactions with live viewing

UI Steps:

  1. Go to Settings → API Credentials → Add Credential
  2. Choose Wizard Mode
  3. Search for "Browser Automation" and select it
  4. The form will show:
    • Auth Type: Bearer Token
  5. Enter:
    • Token: Your Steel API Key (from Steel.dev dashboard)
  6. Click Save Credential
  7. Token is saved securely

What Agents Can Do: Automate complex web interactions, fill forms, click elements, extract data from websites, generate screenshots

Workday (OAuth2 + Tenant URL)

Tools Enabled: Access Workday HR data (worker details, direct reports, organizations, tasks)

UI Steps:

  1. Go to Settings → API Credentials → Add Credential
  2. Choose Wizard Mode
  3. Search for "Workday" and select it
  4. The form will auto-populate with:
    • Auth Type: OAuth2
  5. Enter:
    • Client ID: Your Workday integration Client ID
    • Client Secret: Your Workday Client Secret
    • Tenant URL: Your Workday tenant URL (e.g., https://wd2-impl.workday.com)
  6. Click Save Credential
  7. Click Connect to authorize (if using OAuth2 flow)
  8. Verify "Connected" status

What Agents Can Do: Get worker information, search employees, retrieve organizational hierarchy, access tasks

SurveyMonkey (Bearer Token)

Tools Enabled: Manage SurveyMonkey surveys

UI Steps:

  1. Go to Settings → API Credentials → Add Credential
  2. Choose Wizard Mode
  3. Search for "SurveyMonkey" and select it
  4. The form will show:
    • Auth Type: Bearer Token
  5. Enter:
    • Access Token: Your SurveyMonkey Access Token
  6. Click Save Credential
  7. Token saved securely

What Agents Can Do: List surveys, retrieve responses, create surveys, manage survey data

Generic API Call (Custom API Key)

Tools Enabled: Call any API with custom authentication

UI Steps:

  1. Go to Settings → API Credentials → Add Credential
  2. Choose Wizard Mode or Manual Mode
  3. Search for "Call API" or select API Key auth type in Manual Mode
  4. The form will show:
    • Auth Type: API Key
  5. Enter:
    • API Key: Your custom API key or bearer token
    • Header Name (optional): Specify custom header name (defaults to X-API-KEY)
  6. Click Save Credential
  7. Key saved for use with API Call tool

What Agents Can Do: Authenticate with any REST API using your custom key

Selecting a Credential for an Agent Tool

Once a credential is created and connected, you can assign it to an agent that uses the corresponding tool:

  1. Edit the Agent Workflow: Navigate to the workflow containing the agent you want to configure (see Editing Agent Workflows documentation)
  2. Open the Agent's Configuration: Expand the panel for the specific agent
  3. Add the Tool: Search for and add the tool (e.g., "Gmail", "Outlook Email", "YouTube") from the tools dropdown
  4. Select Credential: A dropdown will appear next to the tool showing all credentials for that service
  5. Choose the Credential: Select the credential you created from the list
  6. Save Workflow Changes: Click to apply changes

Now when this agent uses the tool, it will automatically authenticate using the selected credential.

Managing Existing Credentials

Viewing Connection Status

In the Settings → API Credentials list, you'll see:

  • Green "Connected" badge: OAuth2 credential successfully authorized
  • No badge: API Key/Bearer Token credential (no connection needed)
  • Expired/Error status: Token needs re-authorization

Reconnecting OAuth2 Credentials

If an OAuth2 credential shows as expired or disconnected:

  1. Click on the credential to edit it
  2. Click the Connect button again
  3. Re-authorize through the provider's OAuth flow
  4. Connection status will update to "Connected"

Updating Credentials

To update a credential's title or details:

  1. Go to Settings → API Credentials
  2. Click on the credential to edit
  3. Modify the Title or other editable fields (OAuth2 credentials only allow title changes)
  4. Click Save to update

Deleting Credentials

To remove a credential:

  1. Go to Settings → API Credentials
  2. Click on the credential to edit
  3. Click the Delete button at the bottom
  4. Confirm deletion

Note: Deleting a credential will break any agents currently using it. Make sure to update your workflows before deleting credentials in use.

Troubleshooting

"Connect" button doesn't work

  • Check that your Client ID and Client Secret are correct
  • Verify your OAuth application's Redirect URI includes: https://app.bournelabs.ai/settings/credentials/redirect/{service}
  • Clear browser cookies and try again

OAuth authorization fails

  • Ensure your OAuth app has the required scopes enabled
  • Check that your account has permissions to authorize the app
  • Verify the service's API is enabled in your developer console

Tool returns "Unauthorized" error

  • Verify the credential is showing as "Connected" in the credentials list
  • Try reconnecting the credential (click Edit → Connect)
  • Check that the credential is correctly assigned to the agent's tool

Token expired errors

  • OAuth2 tokens are automatically refreshed by Bourne
  • If auto-refresh fails, manually reconnect the credential
  • Check that your OAuth app's refresh token hasn't been revoked

Overview

The USPTO Trademark Search tools allow you to search and retrieve trademark data from the United States Patent and Trademark Office directly from your agents.

Tools Available

  • trademark_search_by_keyword: Search trademarks by name or keyword
  • trademark_get_status: Get detailed trademark status by serial number
  • trademark_search_by_owner: Find trademarks by owner name or postcode
  • trademark_get_application_metadata: Retrieve complete trademark metadata

Setup Required

None! USPTO Trademark Search tools are ready to use immediately. No credential configuration is needed.

Simply:

  1. Create or edit an agent workflow
  2. Add any of the 4 USPTO Trademark Search tools
  3. Start searching trademarks right away

Example Uses

Brand Name Research:

Search for trademarks containing "TechStart" and tell me if the name is available

Competitor Analysis:

Find all trademarks owned by "Apple Inc" and show their current status

Trademark Status Check:

Get the full details for trademark serial number 88888888 including owner and registration date

Portfolio Audit:

Show me all active trademarks owned by "Microsoft Corporation"

Troubleshooting

No results returned

Possible causes:

  • Trademark doesn't exist in USPTO database
  • Serial number format incorrect (must be 8 digits)
  • Search terms too specific

Solutions:

  • Verify trademark exists at USPTO.gov
  • Check serial number format (e.g., "88888888")
  • Try broader search terms

Tools not appearing

Solution:

  • Refresh the page
  • Clear browser cache
  • Contact support if tools still don't appear

Additional Resources