API Reference

Programmatically manage your blueprints and keep them in sync with your codebase. Available to all users.

Available to All Users

API access is available to all users.Generate your API token to get started.

In this section

Authentication

Generate and manage API tokens

Blueprints API

CRUD operations for blueprints

User API

Access user profile information

Go to Settings → API Tokens and create a new token with the appropriate role.

Use curl or your favorite HTTP client with Bearer authentication:

curl -H "Authorization: Bearer lp_your_token_here" \
     https://lynxprompt.com/api/v1/blueprints

Use the wizard's "Auto update via API" feature to automatically include sync instructions in your downloaded files.

All API requests should be made to:

https://lynxprompt.com/api/v1

API tokens can be created with different roles that determine what actions they can perform:

Role	Permissions
`BLUEPRINTS_FULL`	Read, create, update, and delete blueprints
`BLUEPRINTS_READONLY`	Read-only access to blueprints
`PROFILE_FULL`	Read and update user profile
`FULL`	All permissions (blueprints + profile)

Tokens expire after the duration you set (default: 1 week, max: 1 year). Expired tokens return a 401 Unauthorized response with details:

{
  "error": "Token expired",
  "expired_at": "2025-01-15T10:30:00.000Z"
}

Generate your first API token and start syncing.