GDPR Compliance

We use cookies to ensure you get the best experience on our website. By continuing to use our site, you accept our use of cookies, privacy policy and terms of service.

ESC

What are you looking for?

Newsletter image

Subscribe to our Newsletter

Join 10k+ people to get notified about new posts, news and updates.

Do not worry we don't spam!

Select theme:

Shopping cart

Subtotal
$97.00
View cart Checkout

Your favorites

You have not yet added any recipe to your favorites list.

Browse recipes

Schedule your 15-minute demo now

We’ll tailor your demo to your immediate needs and answer all your questions. Get ready to see how it works!

Propensity Documentation

Propensity is the AI platform for building and deploying intelligent agents, from simple chatbots to complex workflow orchestrations.

Get started with Propensity

Start building AI agents in minutes with our comprehensive platform. Whether you're creating a simple chatbot or a complex workflow orchestration, Propensity provides the tools you need to succeed.

Build your agents

Create powerful AI agents using our intuitive platform. From simple rule-based agents to complex neural network-powered assistants, Propensity supports all your AI development needs.

Deploy and integrate

Deploy your agents across multiple channels and integrate with your existing tools and workflows. Propensity makes it easy to reach your users wherever they are.

Authentication

Propensity uses API keys for authentication. All API requests must include your API key in the Authorization header.

Getting Your API Key

To get your API key:

  1. Log in to your Propensity dashboard
  2. Navigate to Settings → API Keys
  3. Click "Generate New Key"
  4. Copy the key and store it securely

Using Your API Key

Include your API key in all requests:

Authorization: Bearer YOUR_API_KEY

Security Best Practices

  • Never expose your API key in client-side code
  • Rotate your keys regularly
  • Use environment variables to store keys
  • Monitor your API usage for suspicious activity

SDK Installation

Propensity provides official SDKs for popular programming languages to make integration easier.

JavaScript/Node.js

npm install @propensity/sdk

Usage:

import { Propensity } from '@propensity/sdk';

const client = new Propensity('YOUR_API_KEY');

Python

pip install propensity-sdk

Usage:

from propensity import Propensity

client = Propensity('YOUR_API_KEY')

PHP

composer require propensity/sdk

Usage:

use Propensity\Propensity;

$client = new Propensity('YOUR_API_KEY');

API Reference

Our comprehensive API allows you to programmatically create, manage, and interact with your AI agents. All API endpoints return JSON and use standard HTTP response codes.

POST /api/v1/agents

Create Agent

Create a new AI agent with specified configuration

GET /api/v1/agents

List Agents

Retrieve all agents in your account

GET /api/v1/agents/{id}

Get Agent

Retrieve a specific agent by ID

PUT /api/v1/agents/{id}

Update Agent

Update agent configuration and settings

DELETE /api/v1/agents/{id}

Delete Agent

Permanently delete an agent

POST /api/v1/workflows

Create Workflow

Create a new workflow for agent orchestration

POST /api/v1/workflows/{id}/execute

Execute Workflow

Execute a workflow with given parameters

GET /api/v1/workflows/{id}/status

Get Workflow Status

Check the execution status of a workflow

POST /api/v1/voice/synthesize

Text to Speech

Convert text to natural-sounding speech

POST /api/v1/voice/transcribe

Speech to Text

Transcribe audio to text

POST /api/v1/channels/slack/webhook

Slack Webhook

Handle incoming Slack messages

POST /api/v1/channels/whatsapp/webhook

WhatsApp Webhook

Handle incoming WhatsApp messages

POST /api/v1/knowledge/upload

Upload Document

Upload documents to knowledge base

POST /api/v1/knowledge/query

Query Knowledge

Search knowledge base for relevant information

GET /api/v1/analytics/usage

Get Usage Metrics

Retrieve API usage and performance metrics

GET /api/v1/analytics/agents/{id}

Get Agent Analytics

Get performance analytics for a specific agent

Security and compliance

Propensity is built with security and compliance in mind. We implement industry-standard security measures to protect your data and ensure your agents meet regulatory requirements.

  • Data Encryption: All data is encrypted in transit and at rest
  • Access Control: Role-based access control and fine-grained permissions
  • Audit Logging: Comprehensive audit trails for compliance
  • SOC 2 Type II: Certified compliance with security standards

Support and resources

Need help? Our support team is here to assist you with any questions or issues you may have.

  • Documentation: Comprehensive guides and tutorials
  • Community: Join our developer community for discussions and tips
  • Support: Get help from our technical support team
  • Status Page: Check our service status and uptime