Pureframe AI API Documentation

All API requests require a Bearer token in the Authorization header.

Authorization: Bearer pf_...

Creating an API key

Go to Settings → API Keys
Click New Key, give it a name, and choose a permission level
Copy the key: it’s only shown once

Store your API key in an environment variable or secrets manager: never commit it to source control. Keys are prefixed with pf_ so they’re easy to detect in accidental leaks.

Permission levels

Level	Access
`all`	Full read and write: upload, search, manage collections and webhooks
`read_only`	Search and read only; excludes uploads, deletes, and webhook management

Use read_only keys for trusted agent or server integrations that do not need to upload. Do not expose an API key in browser code or other untrusted clients. See API keys for the full object reference and plan limits.

Revoking a key

Revoke a key immediately from the API Keys dashboard if it’s compromised: requests using it will be rejected within seconds.