Skip to main content

API Credentials

This page provides information about all available API credentials in Sidekick Studio. Each credential contains fields required to authenticate with external services.

Table of Contents​

AI Service Credentials​

OpenAI API​

Authentication for OpenAI services.

  • How to obtain: Get your API key from the OpenAI API keys page after creating an account.
  • Inputs:
    • OpenAI Api Key (password)

Azure OpenAI API​

Authentication for Azure OpenAI services.

  • How to obtain: Refer to official guide on how to use Azure OpenAI service.
  • Inputs:
    • Azure OpenAI Api Key (password)
    • Azure OpenAI Api Instance Name
    • Azure OpenAI Api Deployment Name
    • Azure OpenAI Api Version (e.g., 2023-06-01-preview)

Anthropic API​

Authentication for Anthropic Claude models.

Google Vertex Auth​

Authentication for Google Vertex AI services.

  • How to obtain: Create credentials through the Google Cloud Console and set up a service account.
  • Inputs:
    • Google Application Credential File Path (optional)
    • Google Credential JSON Object (optional)
    • Project ID (optional)

Google Generative AI​

Authentication for Google Generative AI services.

  • How to obtain: Get your API key from the official page.
  • Inputs:
    • Google AI API Key (password)

Cohere API​

Authentication for Cohere AI services.

HuggingFace API​

Authentication for HuggingFace services.

  • How to obtain: Create an account at HuggingFace, then go to your profile settings and navigate to the Access Tokens section to create a token.
  • Inputs:
    • HuggingFace Api Key (password)

Mistral AI API​

Authentication for Mistral AI services.

  • How to obtain: Get your API key from the official console.
  • Inputs:
    • MistralAI API Key (password)

Groq API​

Authentication for Groq API services.

Fireworks API​

Authentication for Fireworks AI services.

  • How to obtain: Sign up at Fireworks AI, then get your API key from the account settings.
  • Inputs:
    • Fireworks Api Key (password)

Together AI API​

Authentication for Together AI services.

  • How to obtain: Sign up at Together AI, then access your API key from the account settings.
  • Inputs:
    • TogetherAI Api Key (password)

Alibaba API​

Authentication for Alibaba AI services.

  • How to obtain: Sign up for Alibaba Cloud, then create an API key through the console.
  • Inputs:
    • Alibaba Api Key (password)

Baidu Qianfan API​

Authentication for Baidu's Qianfan AI platform.

  • How to obtain: Register at Baidu AI Cloud, then create and access your Qianfan keys.
  • Inputs:
    • Qianfan Access Key
    • Qianfan Secret Key (password)

Cerebras API​

Authentication for Cerebras AI platform.

  • How to obtain: Sign up at Cerebras AI platform and obtain your API key from the dashboard.
  • Inputs:
    • Cerebras API Key (password) - API Key from cloud.cerebras.ai

Deepseek AI API​

Authentication for DeepseekAI services.

  • How to obtain: Register at DeepseekAI's platform and get your API key from the account settings.
  • Inputs:
    • DeepseekAI API Key (password)

IBM Watsonx​

Authentication for IBM Watsonx AI services.

  • How to obtain: Sign up for IBM Cloud, create a Watsonx service, and get your credentials from the service dashboard.
  • Inputs:
    • Version (YYYY-MM-DD)
    • Service URL
    • Project ID
    • Watsonx AI Auth Type (IAM or Bearer Token)
    • Watsonx AI IAM API Key (optional)
    • Watsonx AI Bearer Token (optional)

Jina AI API​

Authentication for Jina AI services.

  • How to obtain: Get your API key from the official console.
  • Inputs:
    • JinaAI API Key (password)

LocalAI API​

Authentication for LocalAI services.

  • How to obtain: Follow the LocalAI documentation to configure your local API key.
  • Inputs:
    • LocalAI Api Key (password)

OpenRouter API​

Authentication for OpenRouter services.

  • How to obtain: Sign up at OpenRouter and generate your API key from the dashboard.
  • Inputs:
    • OpenRouter API Key (password)

Replicate API​

Authentication for Replicate services.

  • How to obtain: Create an account at Replicate, then go to your account settings to find or create an API token.
  • Inputs:
    • Replicate Api Key (password)

X AI API​

Authentication for X AI services.

  • How to obtain: Apply for access to X AI (formerly known as Twitter's AI services) and receive an API key.
  • Inputs:
    • X AI API Key (password)

Nvidia NIM API​

Authentication for Nvidia NIM platform.

Database Credentials​

Astra DB API​

Authentication for DataStax Astra DB.

  • How to obtain: Create an account at DataStax Astra and generate an application token from the dashboard.
  • Inputs:
    • Astra DB Application Token (password)
    • Astra DB Api Endpoint

MongoDB ATLAS​

Authentication for MongoDB Atlas.

  • How to obtain: Sign up at MongoDB Atlas, create a cluster, and get your connection string from the Connect dialog.
  • Inputs:
    • ATLAS Connection URL

MySQL API​

Authentication for MySQL database.

  • How to obtain: Set up a MySQL server and create user credentials with appropriate permissions.
  • Inputs:
    • User
    • Password

PostgreSQL API​

Authentication for PostgreSQL database.

  • How to obtain: Install PostgreSQL, create a database, and set up user credentials with appropriate permissions.
  • Inputs:
    • User
    • Password

PostgreSQL URL​

Authentication for PostgreSQL using connection string.

  • How to obtain: Set up a PostgreSQL server and construct a connection URL.
  • Inputs:
    • Postgres URL

Neo4j API​

Authentication for Neo4j graph database.

  • How to obtain: Refer to official guide on Neo4j authentication.
  • Inputs:
    • Neo4j URL (e.g., neo4j://localhost:7687)
    • Username
    • Password

Redis API​

Authentication for Redis cache.

  • How to obtain: Set up a Redis server and configure authentication following the Redis documentation.
  • Inputs:
    • Redis Host (default: 127.0.0.1)
    • Port (default: 6379)
    • User
    • Password
    • Use SSL (boolean)

Redis URL​

Authentication for Redis cache using URL.

  • How to obtain: Set up a Redis server and construct a Redis URL.
  • Inputs:
    • Redis URL (default: redis://localhost:6379)

Couchbase API​

Authentication for Couchbase database.

  • How to obtain: Install Couchbase Server, create a bucket, and set up authentication following the Couchbase documentation.
  • Inputs:
    • Couchbase Connection String
    • Couchbase Username
    • Couchbase Password

SingleStore API​

Authentication for SingleStore database.

  • How to obtain: Sign up for SingleStore, create a workspace, and set up user credentials.
  • Inputs:
    • User
    • Password

Search Service Credentials​

Brave Search API​

Authentication for Brave Search.

  • How to obtain: Apply for API access at Brave Search API and get your API key.
  • Inputs:
    • BraveSearch Api Key (password)

Google Custom Search API​

Authentication for Google Search.

Serp API​

Authentication for SERP API.

  • How to obtain: Sign up at SerpAPI and get your API key from the dashboard.
  • Inputs:
    • Serp Api Key (password)

Serper API​

Authentication for Serper API.

  • How to obtain: Register at Serper.dev to obtain your API key.
  • Inputs:
    • Serper Api Key (password)

Search API​

Authentication for Search API.

  • How to obtain: Sign in to SearchApi to obtain a free API key from the dashboard.
  • Inputs:
    • SearchApi API Key (password)

Exa Search API​

Authentication for Exa Search.

  • How to obtain: Refer to official guide on how to get an API Key from Exa.
  • Inputs:
    • ExaSearch Api Key (password)

Tavily API​

Authentication for Tavily Search API.

  • How to obtain: Sign up at Tavily AI and retrieve your API key from the dashboard.
  • Description: Tavily API is a real-time API to access Google search results.
  • Inputs:
    • Tavily Api Key (password)

Vector Store Credentials​

Chroma API​

Authentication for Chroma vector database.

  • How to obtain: Follow the Chroma documentation to set up your account and get API credentials.
  • Inputs:
    • Chroma Api Key (password)
    • Chroma Tenant
    • Chroma Database

Elasticsearch API​

Authentication for Elasticsearch.

  • How to obtain: Refer to official guide on how to get an API Key from ElasticSearch.
  • Inputs:
    • Elasticsearch Endpoint
    • Elasticsearch API Key (password)

ElasticSearch User Password​

Authentication for Elasticsearch using username and password.

  • How to obtain: Refer to official guide on how to get User Password from ElasticSearch.
  • Inputs:
    • Cloud ID (Elastic Cloud ID or server URL)
    • ElasticSearch User
    • ElasticSearch Password

Meilisearch API​

Authentication for Meilisearch.

  • How to obtain: Refer to official guide on how to get an API Key.
  • Inputs:
    • Meilisearch Search API Key (password)
    • Meilisearch Admin API Key (password, optional)

Milvus Auth​

Authentication for Milvus vector database.

  • How to obtain: You can find the Milvus Authentication here.
  • Inputs:
    • Milvus User
    • Milvus Password

OpenSearch​

Authentication for OpenSearch.

  • How to obtain: Set up OpenSearch following the official documentation and create user credentials.
  • Inputs:
    • OpenSearch Url
    • User (optional)
    • Password (optional)

Pinecone API​

Authentication for Pinecone vector database.

  • How to obtain: Sign up at Pinecone, create an index, and get your API key from the dashboard.
  • Inputs:
    • Pinecone Api Key (password)

Qdrant API​

Authentication for Qdrant vector database.

  • How to obtain: Set up Qdrant Cloud or a self-hosted instance and generate your API key.
  • Inputs:
    • Qdrant API Key (password)

Upstash Vector API​

Authentication for Upstash Vector.

  • How to obtain: Sign up at Upstash, create a Vector database, and get your access credentials.
  • Inputs:
    • Upstash Vector REST URL
    • Upstash Vector REST Token (password)

Vectara API​

Authentication for Vectara.

  • How to obtain: Register at Vectara, create a corpus, and obtain your credentials.
  • Inputs:
    • Vectara Customer ID
    • Vectara Corpus ID
    • Vectara API Key (password)

Weaviate API​

Authentication for Weaviate.

  • How to obtain: Sign up for Weaviate Cloud or set up a self-hosted instance and generate an API key.
  • Inputs:
    • Weaviate API Key (password)

Voyage AI API​

Authentication for Voyage AI embedding services.

Content Service Credentials​

Airtable API​

Authentication for Airtable.

  • How to obtain: Refer to official guide on how to get accessToken on Airtable.
  • Inputs:
    • Access Token (password)

Contentful Delivery API​

Authentication for Contentful's content delivery.

  • How to obtain: Refer to official guide on how to get your delivery and preview keys in Contentful.
  • Inputs:
    • Delivery Token
    • Preview Token
    • Space Id

Contentful Management API​

Authentication for Contentful's content management.

  • How to obtain: Refer to official guide on how to get your Management and preview keys in Contentful.
  • Inputs:
    • Management Token
    • Space Id

Confluence Cloud API​

Authentication for Confluence Cloud.

  • How to obtain: Refer to official guide on how to get Access Token or API Token on Confluence.
  • Inputs:
    • Access Token (password)
    • Username/Email
    • Base URL

Confluence Server/Data Center API​

Authentication for Confluence Server or Data Center.

  • How to obtain: Refer to official guide on how to get Personal Access Token on Confluence.
  • Inputs:
    • Personal Access Token (password)

Figma API​

Authentication for Figma.

  • How to obtain: Refer to official guide on how to get accessToken on Figma.
  • Inputs:
    • Access Token (password)

Github API​

Authentication for GitHub.

  • How to obtain: Refer to official guide on how to get accessToken on Github.
  • Inputs:
    • Access Token (password)

Jira API​

Authentication for Jira.

Notion API​

Authentication for Notion.

  • How to obtain: You can find integration token here.
  • Inputs:
    • Notion Integration Token (password)

Salesforce API​

Authentication for Salesforce.

  • How to obtain: Refer to official guide on how to get your Salesforce API key.
  • Inputs:

Slack API​

Authentication for Slack.

  • How to obtain: Refer to official guide on how to get botToken and teamId on Slack.
  • Inputs:
    • Bot Token (password)
    • Team ID

Stripe API​

Authentication for Stripe.

  • How to obtain: Sign up at Stripe, then access your API keys from the Developer Dashboard.
  • Inputs:
    • Stripe API Token (password)

Utility Credentials​

Apify API​

Authentication for Apify.

  • How to obtain: You can find the Apify API token on your Apify account page.
  • Inputs:
    • Apify API (password)

Arize API​

Authentication for Arize observability platform.

AssemblyAI API​

Authentication for AssemblyAI speech-to-text.

  • How to obtain: Create an account at AssemblyAI and obtain your API key from the dashboard.
  • Inputs:
    • AssemblyAI Api Key (password)

AWS security credentials​

Authentication for AWS services.

  • How to obtain: Your AWS security credentials. When unspecified, credentials will be sourced from the runtime environment according to the default AWS SDK behavior.
  • Inputs:
    • AWS Access Key (optional)
    • AWS Secret Access Key (password, optional)
    • AWS Session Key (password, optional)

Azure Cognitive Services​

Authentication for Azure Cognitive Services.

  • How to obtain: Create an Azure account, set up a Cognitive Services resource, and obtain your keys from the Azure portal.
  • Inputs:
    • Azure Subscription Key (password)
    • Service Region (e.g., "westus", "eastus")
    • API Version (default: 2024-05-15-preview)

Composio API​

Authentication for Composio.

  • How to obtain: Sign up at Composio and get your API key from the account settings.
  • Inputs:
    • Composio API Key (password)

Dynamodb Memory API​

Authentication for DynamoDB memory storage.

  • How to obtain: Set up an AWS account, create a DynamoDB table, and generate access credentials with appropriate permissions.
  • Inputs:
    • Access Key (password)
    • Secret Access Key (password)

E2B API​

Authentication for E2B.

  • How to obtain: Sign up at E2B and get your API key from the dashboard.
  • Inputs:
    • E2B Api Key (password)

FireCrawl API​

Authentication for FireCrawl.

Google OAuth​

Authentication for Google services using OAuth.

  • How to obtain: Set up a project in the Google Cloud Console and configure OAuth credentials.
  • Inputs:
    • Full Name (disabled)
    • Email (disabled)
    • Provider (disabled)
    • Provider ID (disabled)
    • Google Access Token (disabled)

Langfuse API​

Authentication for Langfuse monitoring.

Langsmith API​

Authentication for Langsmith.

LangWatch API​

Authentication for LangWatch monitoring.

Lunary AI​

Authentication for Lunary AI monitoring.

Make.Com API​

Authentication for Make.com automation platform.

  • How to obtain: Sign up at Make.com, then access your API key from your profile settings.
  • Inputs:
    • Make.com API Endpoint Url
    • Make.com Api Key (password)
    • Team ID
    • Organization ID

Momento Cache API​

Authentication for Momento Cache.

  • How to obtain: Refer to official guide on how to get API key on Momento.
  • Inputs:
    • Cache
    • API Key (password)
    • Endpoint

N8n API​

Authentication for N8n workflow automation.

Phoenix API​

Authentication for Phoenix monitoring platform.

Spider API​

Authentication for Spider web scraping platform.

  • How to obtain: Get your API key from the Spider dashboard.
  • Inputs:
    • Spider API Key (password)

Supabase API​

Authentication for Supabase.

  • How to obtain: Create a Supabase project and get your API key from the project settings.
  • Inputs:
    • Supabase API Key (password)

Unstructured API​

Authentication for Unstructured document processing.

  • How to obtain: Refer to official guide on how to get api key on Unstructured.
  • Inputs:
    • API Key (password)

Upstash Redis API​

Authentication for Upstash Redis.

  • How to obtain: Refer to official guide on how to create redis instance and get redis REST URL and Token.
  • Inputs:
    • Upstash Redis REST URL
    • Token (password)

Upstash Redis Memory API​

Authentication for Upstash Redis memory storage.

  • How to obtain: Refer to official guide on how to create redis instance and get redis REST Token.
  • Inputs:
    • Upstash Redis REST Token (password)

WolframAlpha App ID​

Authentication for WolframAlpha computational engine.

Zep Memory API​

Authentication for Zep memory storage.

  • How to obtain: Refer to official guide on how to create API key on Zep.
  • Inputs:
    • API Key (password)