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.
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.
All API requests should be made to:
Or your self-hosted instance URL.
API endpoints are versioned to ensure backward compatibility. Current version is v2
.
All requests should include:
All protected endpoints require:
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:
Events System
Prisme.ai uses an event-driven architecture for many operations. The API allows you to:
This event system enables complex workflows and integrations between Prisme.ai and external systems.
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.
The Prisme.ai API is organized into several product areas, each with its own set of endpoints:
Build custom applications and automations
Create and query agents with tools capabilities
Learn how to authenticate with the API
Understand API error codes and troubleshooting
Learn about API usage limits and quotas
Understand our security practices and recommendations
Learn how we version and maintain the API
Try out the API with interactive examples
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.
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.
All API requests should be made to:
Or your self-hosted instance URL.
API endpoints are versioned to ensure backward compatibility. Current version is v2
.
All requests should include:
All protected endpoints require:
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:
Events System
Prisme.ai uses an event-driven architecture for many operations. The API allows you to:
This event system enables complex workflows and integrations between Prisme.ai and external systems.
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.
The Prisme.ai API is organized into several product areas, each with its own set of endpoints:
Build custom applications and automations
Create and query agents with tools capabilities
Learn how to authenticate with the API
Understand API error codes and troubleshooting
Learn about API usage limits and quotas
Understand our security practices and recommendations
Learn how we version and maintain the API
Try out the API with interactive examples