Skip to main content

Key Features

  • Complete Agent Access: Programmatically interact with your AI agents
  • Custom UI Development: Build your own frontend experiences
  • Backend Integrations: Connect with existing systems and workflows
  • Streaming Responses: Support for real-time streaming responses
  • Stateful Conversations: Maintain conversation context and history
  • File Processing: Upload and process documents programmatically
  • Action Execution: Trigger agent workflows and custom actions
  • Webhook Support: Receive notifications for specific events
  • Comprehensive Authentication: Secure your integrations with multiple auth options

Authentication

Shipable API uses API keys for authentication. Generate your API key in the Shipable dashboard under Settings → API. All API requests must include your API key in the header:
API keys have specific permissions. You can create multiple keys with different access levels (read-only, conversation-only, full access).

Implementation Examples

Basic Chatbot Implementation (JavaScript)

Streaming Response Example (JavaScript)

Python Example

Webhooks

Shipable can send webhook notifications for key events to your server:
  1. Go to the Shipable dashboard → Settings → Webhooks
  2. Add a new webhook endpoint URL
  3. Select the events you want to receive notifications for
  4. Configure your server to receive POST requests from Shipable
Example webhook events:
  • conversation.created: New conversation started
  • conversation.completed: Conversation marked as completed
  • message.created: New message in a conversation
  • lead.captured: Lead information collected
  • action.executed: Custom action or workflow executed
Webhook payloads include relevant data and a signature header for verification.

Rate Limits

Rate limit headers are included in all API responses:

Error Handling

The API uses conventional HTTP response codes:
  • 2xx: Success
  • 4xx: Client errors (invalid request, authentication issues)
  • 5xx: Server errors
Example error response: