§.Public API & SDK

REST API overview

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

Updated 2026-04-13

Base URL

https://promptassay.ai/api/v1
Replace promptassay.ai with your self-hosted domain if applicable.

Authentication

Every request requires a Bearer API key in the Authorization header. API keys are workspace-scoped and created from Account settings → API keys. See Creating and managing API keys.

curl -H "Authorization: Bearer pa_live_..." \
  https://promptassay.ai/api/v1/prompts

Response envelope

{
  "data": [ /* resource or array of resources */ ],
  "meta": {
    "page": 1,
    "per_page": 20,
    "total": 142
  }
}

Error responses share a single shape:

{
  "error": {
    "code": "not_found",
    "message": "Prompt not found"
  }
}

Pagination

List endpoints accept page (1-indexed) and per_page (default 20, max 100) query parameters. meta.total is the unfiltered count for the caller's workspace.

Rate limits

  • 100 requests per minute per API key (all paid tiers).
  • Enterprise tier: custom limits available; contact sales.
  • Free tier: public API access is not included — upgrade to Solo or higher.
  • 429 responses include a Retry-After header.