Generated by API Evangelist
Written by API Evangelist tooling for Prisma's API. It is a proposal applied on top of the contract, not a document Prisma publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Prisma Optimize Sessions API
version: 1.0.0
extends: openapi/prisma-sessions-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 4
- target: $.paths['/sessions'].get
update:
x-apievangelist-phrasing:
intent: List Optimize recording sessions
effect: read
questions:
- Which Optimize recording sessions exist in my environment?
- Can I list only the sessions that are still active?
instructions:
- text: List my recording sessions.
- text: Show {limit} recording sessions with status {status}.
slots:
limit: query.limit
status: query.status
method: generated
generated: '2026-09-26'
- target: $.paths['/sessions'].post
update:
x-apievangelist-phrasing:
intent: Start a query recording session
effect: write
questions:
- How do I start recording Prisma Client queries for analysis?
- Which database provider do I have to specify for a new session?
instructions:
- text: Start a recording session for {databaseProvider}.
slots:
databaseProvider: requestBody.databaseProvider
- text: Create an Optimize session named {name} on {databaseProvider}.
slots:
name: requestBody.name
databaseProvider: requestBody.databaseProvider
method: generated
generated: '2026-09-26'
- target: $.paths['/sessions/{sessionId}'].get
update:
x-apievangelist-phrasing:
intent: Get a recording session's details
effect: read
questions:
- What query statistics does a recording session have?
- Has the analysis for my recording session finished?
instructions:
- text: Get recording session {sessionId}.
slots:
sessionId: path.sessionId
- text: Check the analysis status of session {sessionId}.
slots:
sessionId: path.sessionId
method: generated
generated: '2026-09-26'
- target: $.paths['/sessions/{sessionId}'].delete
update:
x-apievangelist-phrasing:
intent: Stop a recording session
effect: destructive
questions:
- How do I stop capturing queries in a recording session?
- Can a stopped session capture new queries again?
instructions:
- text: Stop recording session {sessionId}.
slots:
sessionId: path.sessionId
- text: End {sessionId} and finalize its captured queries.
slots:
sessionId: path.sessionId
method: generated
generated: '2026-09-26'
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.