Blueprints API

Create, read, update, and delete your blueprints programmatically.

Required Role: BLUEPRINTS_FULL for write operations, BLUEPRINTS_READONLY for read-only access.

Blueprint ID Format

Blueprint IDs use the bp_ prefix for easy identification:

bp_clw2m8k0x0001

Endpoints

GET/api/v1/blueprints

List all blueprints you have access to (your own blueprints).

Query Parameters

Parameter	Type	Description
`visibility`	string	Filter by visibility: private, public, or unlisted
`platform`	string	Filter by platform: cursor, claude, copilot, windsurf, agentsmd

Example Request

curl -H "Authorization: Bearer lp_your_token" \
     "https://lynxprompt.com/api/v1/blueprints?visibility=private"

Response

{
  "blueprints": [
    {
      "id": "bp_clw2m8k0x0001",
      "name": "My React Config",
      "description": "Custom rules for React projects",
      "visibility": "private",
      "platform": "cursor",
      "createdAt": "2025-01-15T10:30:00.000Z",
      "updatedAt": "2025-01-20T14:45:00.000Z"
    }
  ],
  "total": 1
}

GET/api/v1/blueprints/:id

Get a specific blueprint by ID, including its full content.

Example Request

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

Response

{
  "id": "bp_clw2m8k0x0001",
  "name": "My React Config",
  "description": "Custom rules for React projects",
  "content": "You are an expert React developer...",
  "visibility": "private",
  "platform": "cursor",
  "variables": [
    { "name": "PROJECT_NAME", "default": "my-app" },
    { "name": "FRAMEWORK", "default": null }
  ],
  "createdAt": "2025-01-15T10:30:00.000Z",
  "updatedAt": "2025-01-20T14:45:00.000Z"
}

POST/api/v1/blueprints

Create a new blueprint.

Request Body

{
  "name": "My New Config",
  "description": "Description of the blueprint",
  "content": "You are an expert developer...",
  "visibility": "private",  // private, public, or unlisted
  "platform": "cursor"      // cursor, claude, copilot, windsurf, agentsmd
}

Example Request

curl -X POST https://lynxprompt.com/api/v1/blueprints \
     -H "Authorization: Bearer lp_your_token" \
     -H "Content-Type: application/json" \
     -d '{
       "name": "My New Config",
       "content": "You are an expert developer...",
       "visibility": "private",
       "platform": "cursor"
     }'

Response

{
  "id": "bp_clw2m8k0x0002",
  "name": "My New Config",
  "visibility": "private",
  "platform": "cursor",
  "createdAt": "2025-01-21T09:00:00.000Z"
}

PUT/api/v1/blueprints/:id

Update an existing blueprint. Only include fields you want to change.

Example Request

curl -X PUT https://lynxprompt.com/api/v1/blueprints/bp_clw2m8k0x0001 \
     -H "Authorization: Bearer lp_your_token" \
     -H "Content-Type: application/json" \
     -d '{
       "content": "Updated content with new rules..."
     }'

Response

{
  "id": "bp_clw2m8k0x0001",
  "name": "My React Config",
  "visibility": "private",
  "platform": "cursor",
  "updatedAt": "2025-01-21T10:00:00.000Z"
}

DELETE/api/v1/blueprints/:id

Delete a blueprint. This action cannot be undone.

Example Request

curl -X DELETE https://lynxprompt.com/api/v1/blueprints/bp_clw2m8k0x0001 \
     -H "Authorization: Bearer lp_your_token"

Response

{ "success": true }

Platform-Specific Commands

Here are examples for updating blueprints from different operating systems:

Linux / macOS (bash)

# Set your API token
export LYNXPROMPT_API_TOKEN="lp_your_token_here"

# Update blueprint from file
curl -X PUT https://lynxprompt.com/api/v1/blueprints/bp_your_id \
     -H "Authorization: Bearer $LYNXPROMPT_API_TOKEN" \
     -H "Content-Type: application/json" \
     -d "{\"content\": $(cat .cursor/rules | jq -Rs .)}"

Requires jq for JSON escaping. Install with brew install jq (macOS) orsudo apt install jq (Linux).

Windows (PowerShell)

# Set your API token
$env:LYNXPROMPT_API_TOKEN = "lp_your_token_here"

# Read file and update blueprint
$content = (Get-Content ".cursor\rules" -Raw) -replace '"', '\"'
$body = @{ content = $content } | ConvertTo-Json
Invoke-RestMethod -Uri "https://lynxprompt.com/api/v1/blueprints/bp_your_id" `
  -Method PUT `
  -Headers @{ "Authorization" = "Bearer $env:LYNXPROMPT_API_TOKEN"; "Content-Type" = "application/json" } `
  -Body $body

WSL (Windows Subsystem for Linux)

Use the same commands as Linux/macOS. To access Windows files, use /mnt/c/... paths.

Syncing from CI/CD

Use the API to automatically sync your AI configuration files from your CI/CD pipeline. Here's an example GitHub Actions workflow:

# .github/workflows/sync-lynxprompt.yml
name: Sync LynxPrompt

on:
  push:
    paths:
      - '.cursor/rules'
      - 'CLAUDE.md'
    branches: [main]

jobs:
  sync:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      
      - name: Sync to LynxPrompt
        run: |
          curl -X PUT https://lynxprompt.com/api/v1/blueprints/bp_your_id \
               -H "Authorization: Bearer ${{ secrets.LYNXPROMPT_API_TOKEN }}" \
               -H "Content-Type: application/json" \
               -d "{\"content\": $(cat .cursor/rules | jq -Rs .)}"

Error Responses

404 Not Found- Blueprint doesn't exist or you don't have access

400 Bad Request- Missing or invalid fields in request body

403 Forbidden- Token doesn't have required permissions