Introduction
Overview of the Prisme.ai API and how to use it effectively
The Prisme.ai API provides a comprehensive set of endpoints that allow you to programmatically interact with all aspects of the Prisme.ai platform. This reference guide will help you understand how to authenticate, make requests, handle errors, and leverage the full capabilities of the API.
API Overview
The Prisme.ai API is organized around RESTful principles. It accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
Base URL
All API requests should be made to:
Or your self-hosted instance URL.
API Versioning
API endpoints are versioned to ensure backward compatibility. Current version is v2
.
Content Type
All requests should include:
Authentication
All protected endpoints require:
Key Concepts
Microservices Architecture
Microservices Architecture
The Prisme.ai API is built on a microservices architecture, with each product and major function having its own dedicated service. The api-gateway service handles authentication, routing, and load balancing across these services.
Main core services include:
- API Gateway: Handles authentication, session management, and request routing
- Workspaces: Manages workspaces
- Runtime: Executes automations and processes events
- Events: Handles event management
- Console: Console for the Prisme.ai platform
- Pages: Renders end-user pages within workspaces
Events System
Events System
Prisme.ai uses an event-driven architecture for many operations. The API allows you to:
- Subscribe to events via webhooks
- Emit events to trigger automations
- Process events in real-time
This event system enables complex workflows and integrations between Prisme.ai and external systems.
Making Your First Request
Here’s a simple example of making an API request to check the system status:
And a more complex example that requires authentication:
Replace YOUR_ACCESS_TOKEN
with a valid access token. See the Authentication page for details on obtaining tokens.
API Products
The Prisme.ai API is organized into several product areas, each with its own set of endpoints:
AI Builder
Build custom applications and automations
AI Knowledge
Create and query agents with tools capabilities
Next Steps
Authentication
Learn how to authenticate with the API
Error Handling
Understand API error codes and troubleshooting
Rate Limits
Learn about API usage limits and quotas
Security
Understand our security practices and recommendations
Versioning
Learn how we version and maintain the API
Playground
Try out the API with interactive examples