canonical: https://jentic.com/apis/prismatic.io/prismatic

# Prismatic Integration Platform API

Jentic publishes the only available OpenAPI specification for Prismatic Integration Platform API, keeping it validated and agent-ready. Prismatic API provides management access to an embedded integration platform, exposing 5 endpoints for listing integrations, retrieving integration details, browsing available components, managing customer records, and viewing deployed instances. The platform enables B2B SaaS companies to build, deploy, and monitor customer-facing integrations at scale.

## For AI agents

List and inspect integrations, components, customers, and deployed instances on the Prismatic embedded integration platform. Manage B2B SaaS integration deployments.

## Scope

Does not handle integration flow building, trigger configuration, or code deployment - use for listing and inspecting existing integrations, components, and deployment instances only.

## Capabilities

- List all integrations configured on the Prismatic platform with their metadata
- Retrieve detailed configuration for a specific integration by ID
- Browse available integration components and their connection types
- View customer records and their associated integration deployments
- Monitor deployed integration instances across the customer base

## Use cases

### Integration Catalog Management

Monitor and inspect the catalog of integrations built on the Prismatic platform. The API lists all configured integrations with their names, descriptions, and IDs. This enables B2B SaaS companies to programmatically audit their integration portfolio, check which integrations exist, and retrieve configuration details for specific integrations without using the Prismatic dashboard.

Example prompt: List all integrations on the Prismatic platform and return the name and ID for each, then retrieve full details for the first integration

### Customer Deployment Monitoring

Track which customers have active integration instances deployed and monitor the state of those deployments. The instances endpoint returns all deployed integration instances across the customer base, while the customers endpoint shows which organizations are configured. This enables proactive monitoring of integration health across a B2B customer portfolio.

Example prompt: List all customers, then list all instances, and cross-reference to identify customers without any active integration instances

### Component Discovery for Integration Building

Browse the available component catalog to identify connectors and actions that can be used when building new integrations. Components represent the building blocks of Prismatic integrations, each providing connections to external services. Agents can query the catalog to determine which services are supported before designing a new integration flow.

Example prompt: List all available components on the Prismatic platform and count how many are currently registered

### AI Agent Integration Platform Management

AI agents can use the Prismatic API through Jentic to automate integration platform operations such as auditing deployment status, discovering available components, and monitoring customer integration health. Jentic provides credential isolation and operation schemas so agents manage the integration platform without accessing raw bearer tokens.

Example prompt: Search Jentic for 'list prismatic integrations', load the listIntegrations operation schema, and execute to retrieve the full integration catalog

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/integrations` | List all configured integrations |
| GET | `/integrations/{id}` | Get details of a specific integration |
| GET | `/components` | List available integration components |
| GET | `/customers` | List customers on the platform |
| GET | `/instances` | List deployed integration instances |

## Key resources

- **Integrations** — List and retrieve integration configurations with names, descriptions, and metadata
- **Components** — Browse available connector components for building integrations
- **Customers** — View customer records associated with the integration platform
- **Instances** — Monitor deployed integration instances across customers

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 67 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 87 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 47 / 100
  - Agent Usability: 94 / 100
  - Security: 60 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/prismatic.io/prismatic/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Prismatic Integration Platform API by hand means managing its bearer token and pointing every call at app.prismatic.io/api yourself. Through Jentic you install once, import Prismatic from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Prismatic puts the integration id in the URL path (`/integrations/{id}`), so a rule can pin your agent to inspecting a specific integration. You choose the operations it may call, so it stays read-only across integrations, components, and instances unless you add more.
- **Credential handling:** Your Prismatic bearer token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list Prismatic integrations' or 'check integration deployment status', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Zapier API** — Consumer-focused integration platform vs Prismatic's embedded B2B approach
- **Shopify API** — E-commerce platform commonly integrated through Prismatic for B2B order flows
- **Stripe API** — Payment processing commonly connected through Prismatic integration flows

## FAQ

### Why is there no official OpenAPI spec for Prismatic Integration Platform API?

Prismatic does not publish an OpenAPI specification for their REST API. Jentic generates and maintains this spec so that AI agents and developers can call Prismatic Integration Platform API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Prismatic API use?

The Prismatic API uses Bearer token authentication. Include your API token in the Authorization header as 'Bearer your-token'. Through Jentic, the bearer token is stored encrypted in the vault and agents receive scoped access without handling raw credentials.

### Can I list all deployed integration instances with the Prismatic API?

Yes. The GET /instances endpoint returns all deployed integration instances across your customer base. Each instance includes its configuration and deployment status. Combined with GET /customers, you can map which customers have active deployments and identify any without running instances.

### What are the rate limits for the Prismatic API?

The Prismatic API specification does not document explicit rate limits. Standard API rate limiting practices apply. If you receive 429 responses, implement exponential backoff. For high-volume monitoring use cases, cache results locally and poll at reasonable intervals.

### How do I discover available integration components through Jentic?

Search Jentic for 'list prismatic components', load the listComponents operation schema, and execute the call. The response returns all available connector components that can be used to build integrations. Install with pip install jentic and set your JENTIC_AGENT_API_KEY environment variable.

### Is the Prismatic API the same as their GraphQL API?

No. Prismatic primarily uses a GraphQL API for their full platform capabilities. This REST API covers a subset of operations for listing integrations, components, customers, and instances. For advanced operations like creating integrations or configuring flows, the GraphQL API provides broader coverage.

### Can I limit what my agent is allowed to do with the Prismatic Integration Platform API?

Yes. Jentic One is self-hosted, so your own rules decide which Prismatic operations the agent may call and which credentials it may use. Because the integration id sits in the URL path at GET `/integrations/{id}`, you can pin the agent to inspecting a single integration, and you can keep it read-only across the /integrations, /components, /customers, and /instances endpoints by granting only the list and retrieve operations. The agent can call nothing you have not explicitly allowed.