Is the API included in every plan?

Yes — API access isn't gated behind a higher tier. Any account can generate a key and read its own documents.

Is there a rate limit?

Yes, a sane per-key limit applies to keep the service stable for everyone. Details are in the Help Center's API docs.

Can I create multiple keys?

Yes — generate separate keys for different scripts or integrations, and revoke any one of them individually without affecting the others.

What happens if a key is compromised?

Revoke it immediately from your dashboard. Revocation takes effect right away, and a new key can be generated in its place.

Can the API upload or trigger a new takeoff?

Not currently — it's read-only. Uploads and auto-detection runs go through the web app.

● Public API

A real, read-only API for your own documents.

List your uploaded plan sets and pull a labeled material summary straight into your own scripts, spreadsheets, or internal tools — authenticated with an account-scoped key you control.

Isometric illustration of a stack of documents connected by an arrow to a gear icon representing an API connection

How it works

From an API key to a material summary, in three steps.

Generate a key

Create an account-scoped API key from your dashboard. Keys are prefixed and hashed server-side — the raw key is shown to you exactly once, the same way most modern APIs handle it.

Authenticate your request

Pass your key as a bearer token or a dedicated header. Every request is scoped strictly to your own account's documents — there's no way for a key to see data outside the account that created it.

Read your documents and results

List your uploaded documents, then pull a labeled material summary for any of them — the same matched/ambiguous/needs-confirmation data you see in the dashboard, in a format your own code can consume.

A real example

What a request actually looks like.

curl https://api.readmyblueprint.com/v1/documents \
  -H "Authorization: Bearer rmb_live_..."

curl https://api.readmyblueprint.com/v1/documents/doc_123/summary \
  -H "Authorization: Bearer rmb_live_..."

Full endpoint reference, request/response shapes, and rate limits are documented on the Help Center's API section.

Scope, on purpose

Read-only, by design — for now.

The public API currently supports reading your own documents and their material summaries — it doesn't upload new plan sets or trigger auto-detection runs. That's a deliberate starting scope: read access is enough to build a lot of useful things (pulling results into an internal dashboard, syncing to a spreadsheet, feeding another tool) without the additional risk surface of a write API that can trigger billable actions or modify account data.

FAQ

Common questions about the API.

Is the API included in every plan?: Yes — API access isn't gated behind a higher tier. Any account can generate a key and read its own documents.
Is there a rate limit?: Yes, a sane per-key limit applies to keep the service stable for everyone. Details are in the Help Center's API docs.
Can I create multiple keys?: Yes — generate separate keys for different scripts or integrations, and revoke any one of them individually without affecting the others.
What happens if a key is compromised?: Revoke it immediately from your dashboard. Revocation takes effect right away, and a new key can be generated in its place.
Can the API upload or trigger a new takeoff?: Not currently — it's read-only. Uploads and auto-detection runs go through the web app.

Generate your first API key.

Create a key from your dashboard and start reading your own documents in minutes.

Get started