Build on Neuraphic
Each product ships its own API reference, SDKs, and guides. Open a product to dive in — the topics below apply across the whole platform.
Common questions
Where do I find the developer documentation?
The full developer reference lives in your dashboard at apps.neuraphic.com, alongside your projects and keys. This help section covers the concepts — keys, authentication, limits, webhooks, and tooling — that apply across the platform.
How do I create and manage API keys?
Create keys from your dashboard. A key is shown once at creation — store it in a secret manager, never in source control. Scope each key to the minimum it needs, use separate keys per environment, and rotate them on a schedule. You can revoke a key at any time; revocation takes effect immediately across the platform.
How does authentication work?
Requests are authenticated with a bearer token in the Authorization header over TLS. Tokens are tied to your account and scope. Treat every token as a secret; if one is exposed, revoke it and issue a new one. For end-user sign-in flows in your own product, see Account & security.
What are the rate limits?
Limits are applied per key and per account and are returned on every response in the rate-limit headers. When you exceed a limit you receive a 429 with a Retry-After hint. Back off and retry with jitter rather than hammering the endpoint. Higher quotas are available on paid plans.
How do webhooks work?
Webhooks deliver events to an HTTPS endpoint you control. Every payload is signed; verify the signature before trusting it, and respond 2xx quickly — do the real work asynchronously. Deliveries are retried with backoff on failure, so make your handler idempotent using the event ID.
Are there SDKs and a CLI?
Yes. Official SDKs and a command-line tool are available from your dashboard, with quickstarts for common languages. The CLI handles authentication, environment management, and deploys so you can script your workflow end to end.
How do I read API errors?
Errors use standard HTTP status codes with a structured JSON body containing a stable error code, a human-readable message, and a request ID. Log the request ID — including it lets support trace a failed call directly. Branch your handling on the code, not the message text.
How do I get developer support?
Email [email protected] with the request ID, the endpoint, and the expected vs. actual behavior. For security issues, follow responsible disclosure. For sales or partnership inquiries, use the contact page.