§.Documentation

The manual.

The working manual for PromptAssay. Getting started, the public API, how BYOK works, pricing details, and the questions we get asked most.

21 articles · 12 sections

Getting started

3 articles

Welcome to PromptAssay

What PromptAssay is, who it's for, and the core concepts you'll use every day.

Read

Core concepts

User vs workspace, personal vs team, prompts vs versions vs fragments, and what the free tier actually gives you.

Read

Keyboard shortcuts

Every keyboard shortcut PromptAssay supports, and the fastest paths through the app.

Read

Import & export

1 article

Supported import / export formats

Markdown, Anthropic JSON, OpenAI JSON, raw text, and the PromptAssay bundle — when to use each.

Read

Public API & SDK

4 articles

REST API overview

Base URL, authentication, response envelope, pagination, and rate limits for the public `/api/v1` surface.

Read

Endpoint reference

Every `/api/v1` endpoint with method, parameters, and an example request.

Read

TypeScript SDK

Install, configure, and use the official TypeScript SDK for the public REST API.

Read

Error codes and handling

Every error code the public API returns, what causes it, and how to recover.

Read

Workspaces & collaboration

1 article

Personal vs team workspaces

The two workspace types, why personal workspaces are single-member forever, and why team workspaces are everything else.

Read

BYOK provider keys

1 article

What BYOK is and why it's workspace-scoped

Per-workspace API keys for Anthropic / OpenAI / Google, how they're shared across members, and why the user-scoped alternative doesn't exist.

Read

Billing & plans

2 articles

Plans and limits

Free / Solo / Team / Enterprise — monthly call quota, member caps, team-workspace cap, API access, and SSO.

Read

Understanding the free tier

500 calls per month, BYOK required, no API access, and how to check your remaining quota.

Read

Account & security

1 article

Signing up and logging in

Email + password with hCaptcha, OAuth (Google), magic links, and invitation acceptance.

Read

Navigation & UX

1 article

Light and dark themes

Toggling the theme and how design tokens drive both modes.

Read

Legal & compliance

2 articles

Cookie consent

The banner, essential vs non-essential cookies, and how to change your consent.

Read

Your GDPR rights

Access, export, correction, deletion, and objection — where each right is surfaced in-app.

Read

Troubleshooting

1 article

"hCaptcha verification failed"

Why the captcha might fail and how to retry without getting stuck in a loop.

Read

FAQ

3 articles

Which LLM model should I pick?

Decision matrix: speed vs quality vs cost for each supported model.

Read

Can I use a local or self-hosted model?

Today: Anthropic, OpenAI, Google only. What's on the roadmap.

Read

How much does a single call cost?

Typical cost ranges for the most common models and an example calculation.

Read

Glossary

1 article

Glossary of terms

PromptAssay-specific terminology in one place: workspace, BYOK, tier, and more.

Read

API reference

Prefer endpoints and code samples?

The full REST reference for the public API: endpoints, authentication, rate limits, error codes.

Open API reference