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:

https://api.studio.prisme.ai

Or your self-hosted instance URL.

API Versioning

API endpoints are versioned to ensure backward compatibility. Current version is v2.

https://api.studio.prisme.ai/v2/...

Content Type

All requests should include:

Content-Type: application/json

Authentication

All protected endpoints require:

Authorization: Bearer YOUR_TOKEN

​
Key Concepts

​
Making Your First Request

Here’s a simple example of making an API request to check the system status:

curl -X GET "https://api.studio.prisme.ai/" \
     -H "Content-Type: application/json"

And a more complex example that requires authentication:

curl -X GET "https://api.studio.prisme.ai/v2/workspaces" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

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

Was this page helpful?

Raise issue