Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pixcraft.es/llms.txt

Use this file to discover all available pages before exploring further.

Get Capabilities

GET /api/v1/capabilities
Returns all available niches, feature flags, and your current plan information. This is the first endpoint you should call to understand what the API offers. New niches added to PixCraft automatically appear here without any code changes.

Authentication

Authorization
string
required
Bearer token. Example: Bearer px_live_your_key

Response

version
string
API version (currently "1.0")
niches
array
List of available niches with their default configuration.
features
object
Feature flags indicating what the API currently supports.
plan
object
Your plan details including usage and remaining calls.

Example response

{
  "version": "1.0",
  "niches": [
    {
      "id": "curtains",
      "name": "Cortinas",
      "defaultUnitWidth": 1.5,
      "defaultUnitHeight": 2.0,
      "supportedFormats": ["json", "pdf"]
    },
    {
      "id": "mosaics",
      "name": "Mosaicos",
      "defaultUnitWidth": 2.0,
      "defaultUnitHeight": 2.0,
      "supportedFormats": ["json", "pdf"]
    }
  ],
  "features": {
    "pdf_generation": true,
    "custom_color_catalog": true,
    "marketplace_access": true,
    "image_validation": true
  },
  "plan": {
    "name": "business",
    "monthly_limit": 5000,
    "usage_this_month": 243,
    "remaining": 4757
  }
}

Notes

  • The niches list is generated dynamically from PixCraft’s internal configuration. When a new niche is added, it appears here automatically.
  • If your API key has allowed_niches restrictions, only those niches will be returned.
  • Enterprise plans show "unlimited" for monthly_limit and remaining.