Customer API reference

This read-only reference covers the 74 supported customer operations across authentication, API keys, workspaces, builds, projects, processors, artifacts, billing, analytics, and account management. The method, path, security requirements, response status, media type, and schemas shown on operation pages are generated from the reviewed OpenAPI contract; the prose explains how to use that contract safely.

The reference never asks for a JWT or nfy_ key and never sends a business API request. During the compatibility release, the legacy Swagger UI remains available for teams that still depend on it, but new integrations should use these pages and the machine-readable /v3/api-docs contract.

Authentication boundaries

• Public operations need no credential.
• Dashboard and account operations require a JWT access token.
• Canonical docs expose scoped nfy_ automation keys on build, project, saved-processor, analytics, and self-disable operations; each operation states its minimum and conditional scopes.
• Legacy /api/v1/compile/** routes also recognize those keys and still execute for compatibility, but are deliberately omitted from the canonical contract and navigation.

Start with API keys and authentication before automating a build, and read errors, limits, and retries before implementing polling or resubmission.