Skip to main content
API integrations are a core component of the Prisme.ai Apps Marketplace, enabling your AI solutions to connect with external services and systems. These integrations allow you to incorporate data from other platforms, trigger actions in external systems, and build comprehensive workflows that span multiple services.

​
Understanding API Integrations

API integrations on Prisme.ai provide a standardized way to interact with external services:

Simplified Authentication

Secure credential management without exposing sensitive information

Standardized Interface

Consistent patterns for interacting with diverse services

Parameter Validation

Input validation to prevent errors and ensure proper data format

Error Handling

Consistent error reporting and recovery mechanisms
These features make it easier to connect to external systems without dealing with the complexity of raw API interactions.

​
How API Integrations Work

API integrations in Prisme.ai follow a consistent pattern:
1

Authentication Configuration

Each API integration requires credentials to access the external service. These are securely stored and managed within the platform.
2

Action Definition

Integrations expose a set of actions (such as “Send Email” or “Create Contact”) that represent operations in the external system.
3

Parameter Mapping

When using an action, you map data from your workflow to the parameters required by the external API.
4

Execution

The platform handles the API call, including authentication, request formatting, and response processing.
5

Response Handling

The response from the external system is parsed and made available to your workflow for further processing.
This standardized approach simplifies integration with external systems while maintaining flexibility and control.

​
Example: Mailjet Integration

Let’s look at an example of an API integration with Mailjet, a popular email service:
  • Installation
  • Configuration
  • Using in Automations
  • Advanced Options
1

Access the Marketplace

Navigate to the Apps section in your Prisme.ai workspace
2

Find the Mailjet App

Search for “Mailjet” or browse the Communication category
3

Install the App

Click “Install” to add the Mailjet app to your workspace
4

Configure Authentication

Enter your Mailjet API Key and Secret Key when prompted
API_KEY: your_mailjet_api_key
SECRET_KEY: your_mailjet_secret_key
These credentials are encrypted and securely stored.

​
Common API Integration Types

The Apps Marketplace includes API integrations across several categories:
Integrations with email, messaging, and notification platforms:
  • Email Services: Mailjet, SendGrid, SMTP providers, Gmail
  • Messaging Platforms: Slack, Microsoft Teams, Discord, Telegram
  • SMS Gateways: Twilio, Vonage, MessageBird
  • Push Notification Services: Firebase, OneSignal, Pushwoosh
These integrations allow your AI solutions to communicate through various channels, reaching users where they are most active.
Integrations with customer relationship management and engagement tools:
  • CRM Platforms: Salesforce, HubSpot, Microsoft Dynamics, Zoho
  • Support Systems: Zendesk, Freshdesk, ServiceNow
  • Marketing Automation: Marketo, Mailchimp, Braze, Iterable
  • Survey Tools: SurveyMonkey, Typeform, Google Forms
These connections enable AI-driven customer engagement across the entire customer lifecycle.
Integrations with work management and collaboration tools:
  • Project Management: Jira, Asana, Trello, Monday.com
  • Document Storage: Google Drive, Dropbox, Box, OneDrive
  • Knowledge Bases: Confluence, Notion, SharePoint
  • Calendar Services: Google Calendar, Outlook, Calendly
These integrations allow AI solutions to participate in and enhance team workflows.
Integrations with data storage and analysis platforms:
  • Analytics Tools: Google Analytics, Mixpanel, Amplitude
  • Business Intelligence: Tableau, Power BI, Looker
  • Data Warehousing: Snowflake, BigQuery, Redshift
  • Data Enrichment: Clearbit, ZoomInfo, FullContact
These connections enable data-driven AI solutions with access to rich analytics and insights.

​
Building Custom API Integrations

While the marketplace includes many pre-built integrations, you can also create custom API integrations for your specific needs:
1

Create a New Workspace

Start by creating a dedicated workspace for your API integration
2

Define the API Interface

Create an automation that encapsulates the API interaction:
slug: api-action-name
name: Descriptive Action Name
do:
  - fetch:
      emitErrors: true
      outputMode: body
      headers:
        Content-Type: application/json
        Authorization: "Bearer {{config.api_token}}"
      url: https://api.example.com/endpoint
      method: post
      body:
        key1: "{{param1}}"
        key2: "{{param2}}"
      output: response
arguments:
  param1:
    type: string
    title: Parameter 1
    description: Description of parameter 1
  param2:
    type: string
    title: Parameter 2
    description: Description of parameter 2
3

Configure Authentication

Set up the workspace configuration schema to handle authentication credentials:
config:
  schema:
    api_token:
      title: API Token
      description: Authentication token for the API
      type: string
4

Create Documentation

Add a documentation page to explain how to use your integration:
slug: _doc
name:
  fr: Documentation
  en: Documentation
blocks:
  - slug: RichText
    content: |-
      <h1>API Integration Name</h1> 
      <p>
        Description of what this integration does and how to use it.
      </p>
5

Publish as an App

Publish your workspace as an app to make it available in your organization’s marketplace
This approach allows you to create standardized interfaces for any API, making them available across your organization.

​
Authentication Methods

API integrations in Prisme.ai support various authentication methods:

API Keys

Simple key-based authentication used by many services

OAuth 2.0

Token-based authentication with user consent flows

Basic Auth

Username/password authentication encoded in headers

JWT

JSON Web Token based authentication
The platform securely manages these credentials, protecting sensitive information while enabling authenticated API access.

​
Best Practices for API Integrations

Follow these recommendations when working with API integrations:
  • Use the minimum permissions necessary for your integration
  • Rotate credentials regularly for sensitive integrations
  • Consider OAuth for user-specific operations where applicable
  • Review API permissions and scopes carefully
  • Monitor API usage for unusual patterns
  • Follow the principle of least privilege when configuring access
  • Implement caching for frequently accessed data
  • Batch operations when possible to reduce API calls
  • Consider rate limits and implement appropriate throttling
  • Monitor response times and optimize slow operations
  • Use pagination for large data sets
  • Implement retry logic with exponential backoff for transient failures
  • Implement comprehensive error handling for API calls
  • Provide meaningful error messages to users
  • Log detailed error information for troubleshooting
  • Handle rate limiting and quota errors gracefully
  • Implement circuit breakers for unreliable services
  • Consider fallback options for critical operations
  • Stay informed about API changes and deprecations
  • Test integrations regularly to ensure functionality
  • Update authentication credentials before expiration
  • Document integration details for future reference
  • Monitor for security advisories related to integrated services
  • Maintain version compatibility with API providers

​
Using API Integrations with AI Knowledge and Agents

API integrations can significantly enhance your AI Knowledge bases and agents:

Dynamic Information

Incorporate real-time data from APIs into AI responses

Action Capabilities

Enable AI agents to perform actions through API calls

Data Enrichment

Enhance knowledge bases with information from external sources

Process Automation

Allow agents to initiate and manage business processes
These capabilities transform AI from passive information providers to active participants in business workflows.

​
Example Use Cases

  • Customer Support
  • Sales Assistance
  • Research Companion
  • Operational Workflow
A customer support agent that can:
  • Retrieve customer information from CRM
  • Check order status from e-commerce platform
  • Create support tickets in ticketing system
  • Send confirmation emails to customers
  • Schedule follow-up calls in calendar
This provides a comprehensive support experience within a single conversation.

​
Next Steps

Crawler

Learn about web content extraction capabilities

Custom Code

Explore executing custom logic within workflows

Collection

Discover simplified database access

Building Custom Apps

Create your own API integrations
⌘I