API

Your reads, from your own tools

Send a link, get the summary, the full read, a share link or JSON back.

Keys come with any plan.

Quickstart

Create a report

curl https://api.prismiq.pro/v1/reports \
  -H "Authorization: Bearer pq_live_..." \
  -H "Content-Type: application/json" \
  -d '{"url": "https://www.youtube.com/watch?v=VIDEO_ID", "product": "pulse"}'

Poll for it

curl https://api.prismiq.pro/v1/reports/rep_6f1c... \
  -H "Authorization: Bearer pq_live_..."

About two minutes for Pulse, about seven for Amplify.

{
  "id": "rep_6f1c...",
  "product": "pulse",
  "status": "completed",
  "outputs": {
    "summary": "A strong hook, a slow middle.\nTighten the intro and lead with the result.",
    "link": "https://app.prismiq.pro/public/feedback/9f2a41c07b3d58e6"
  }
}

What you get

summary The hero lines.
full The whole read as plain text.
link A share page.
json The structured read with score, checks, hook, packaging and the moves.

Pass sections to trim full to the parts you want.

Pricing

One credit per report. The same Pulse and Amplify credits as the app, from the same account. A second call for the same video and product from your account within a day returns the first report free, unless you pass force.

Limits

Reads	60 a minute
Report creations	10 a minute
Calls	1,000 a day
Running at once	3
Trial keys	5 a minute, 300 a day, 2 running

Every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset, and a 429 adds Retry-After.

Callbacks

Pass a callback URL and we post the finished report to it. Each post is signed so you can check it came from us. We try three times.

X-Prismiq-Event: report.completed
X-Prismiq-Signature: sha256=...
X-Prismiq-Attempt: 1

Public hosts only.

Errors

Status	Type	What to do
401	authentication	Check the key and send it as a Bearer token.
402	insufficient_credits	Add credits in the app, then try again.
403	permission	The key lacks the scope or the plan for this call.
404	not_found	Check the report id; it belongs to your account.
400 or 422	invalid_request	Fix the field named in the message and resend.
429	rate_limited	Wait for the Retry-After seconds, then retry.
500	server_error	Retry in a moment; if it persists, tell us.
503	server_error	We are briefly busy; retry shortly.

Every error is the same shape: type, code, a sentence you can show, and a link here.

Reference

Full reference Every field, with examples.

Discord

A Prismiq bot for Discord is next. It will use this same API.

Questions.

Do I need a new account?

No. Keys live in your account.

Does it cost more?

No. Reports use the same credits as the app.

Can I try it without a plan?

Keys come with any plan. The app's free credit is the trial.

Build on your reads.

Get your key

Read the reference