Overview

What is the Prisma API?

A Prisma service exposes a GraphQL API that is automatically generated based on the deployed data model. It is also referred to as the Prisma API. The Prisma API defines CRUD operations for the types in the data model and allows to get realtime updates when events are happening in the database (e.g. new nodes are created or existing ones updated or deleted).

<InfoBox>

The Prisma API is defined by a corresponding GraphQL schema, called Prisma database schema.

</InfoBox>

Exploring the Prisma API

The GraphQL Playground is the best tool to explore the Prisma API and get to know it better. You can use it to run GraphQL mutations, queries and subscriptions.

To open up a Playground for your database service, simply run the prisma playground command in the working directory of your service or paste your service's HTTP endpoint into the address bar of your browser.