> ## Documentation Index
> Fetch the complete documentation index at: https://docs.prisme.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.

<CardGroup cols="2">
  <Card title="Base URL" icon="globe">
    All API requests should be made to:

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

    Or your self-hosted instance URL.
  </Card>

  <Card title="API Versioning" icon="code-branch">
    API endpoints are versioned to ensure backward compatibility. Current version is `v2`.

    ```
    https://api.studio.prisme.ai/v2/...
    ```
  </Card>

  <Card title="Content Type" icon="file-code">
    All requests should include:

    ```
    Content-Type: application/json
    ```
  </Card>

  <Card title="Authentication" icon="key">
    All protected endpoints require:

    ```
    Authorization: Bearer YOUR_TOKEN
    ```
  </Card>
</CardGroup>

## Key Concepts

<Accordion title="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
</Accordion>

<Accordion title="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.
</Accordion>

## Making Your First Request

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

```bash theme={null}
curl -X GET "https://api.studio.prisme.ai/" \
     -H "Content-Type: application/json"
```

And a more complex example that requires authentication:

```bash theme={null}
curl -X GET "https://api.studio.prisme.ai/v2/workspaces" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
```

<Warning>
  Replace `YOUR_ACCESS_TOKEN` with a valid access token. See the [Authentication](/api-reference/authentication) page for details on obtaining tokens.
</Warning>

## API Products

The Prisme.ai API is organized into several product areas, each with its own set of endpoints:

<CardGroup cols="3">
  <Card title="Builder" icon="hammer">
    Build custom applications and automations
  </Card>

  <Card title="Knowledges" icon="database">
    Create and query agents with tools capabilities
  </Card>
</CardGroup>

## Next Steps

<CardGroup cols="3">
  <Card title="Authentication" icon="key" href="/api-reference/authentication">
    Learn how to authenticate with the API
  </Card>

  <Card title="SDKs" icon="code" href="/api-reference/sdks">
    Start from the official Node.js and Python SDK repositories
  </Card>

  <Card title="Error Handling" icon="triangle-exclamation" href="/api-reference/errors">
    Understand API error codes and troubleshooting
  </Card>

  <Card title="Rate Limits" icon="gauge-high" href="/api-reference/rate-limits">
    Learn about API usage limits and quotas
  </Card>

  <Card title="Security" icon="shield" href="/api-reference/security">
    Understand our security practices and recommendations
  </Card>

  <Card title="Versioning" icon="code-branch" href="/api-reference/versioning">
    Learn how we version and maintain the API
  </Card>
</CardGroup>