API and embeds

Everything the workspace does goes through a public HTTP API, so your own systems can create optimization jobs and read their results.

API keys

Create a key in Settings. The full key is shown once: copy it to your secret store then, because NestSmart keeps only a one-way hash of it and cannot show it again. Revoke a key at any time; requests with it stop working at once. Keys belong to an organization and act within it.

Requests and errors

• Send the key as a bearer token over HTTPS.
• Errors are JSON problem documents with a machine-readable code, such as VALIDATION_FAILED with every invalid field listed at once.
• Requests are rate limited per key; a 429 response says when to retry.
• Writes accept an idempotency key, so a retried request never runs a job twice.

Embedding the optimizer

The embeddable optimizer puts NestSmart inside your own website. Configure it in Settings → Embeddable optimizer, which issues short-lived embed tokens scoped to your organization.