# NestAPI Documentation ## Docs - [Introduction](https://docs.nestapi.com/introduction.md): Nesting-as-a-service for CAD/CAM and sheet-fabrication software. - [Authentication](https://docs.nestapi.com/authentication.md): Every request is authenticated with an API key sent as a Bearer token. - [Quickstart](https://docs.nestapi.com/quickstart.md): Submit a DXF nesting request and receive the result via webhook. - [Nesting workflow](https://docs.nestapi.com/guides/nesting-workflow.md): The asynchronous submit → RequestId → result model, with SignalR and delayed start. - [Webhooks](https://docs.nestapi.com/guides/webhooks.md): How nesting results are delivered to your endpoint, and how to secure it. - [Geometry types](https://docs.nestapi.com/guides/geometry-types.md): The ways to describe parts to NestAPI: DXF files, encoded geometry, parametric, and MyNesting XML. - [Quote nesting](https://docs.nestapi.com/guides/quote-nesting.md): Fast material-usage estimates for quoting, without producing full production output. - [1D nesting](https://docs.nestapi.com/guides/1d-nesting.md): Optimise linear cutting of bar, tube, and profile stock. - [Parts and sheets](https://docs.nestapi.com/concepts/parts-and-sheets.md): The two things every nest needs: what to cut, and what to cut it from. - [Nesting settings](https://docs.nestapi.com/concepts/nesting-settings.md): The knobs that control how parts are placed: spacing, rotations, and material handling. - [Common cutting](https://docs.nestapi.com/concepts/common-cutting.md): Letting adjacent parts share a cut line to save material and cutting time. - [Export types](https://docs.nestapi.com/concepts/export-types.md): Turning a completed nest into production output and reports. - [API keys](https://docs.nestapi.com/account/api-keys.md): Key classes, programmatic lifecycle management, and browser-origin (CORS) control. - [Fairness](https://docs.nestapi.com/account/fairness.md): Share your account's nesting minutes fairly across the customers you resell to. - [Identity & account status](https://docs.nestapi.com/account/profile.md): Check who a key belongs to, whether it's valid, when it expires, and what your account has left. - [Revoke an API key](https://docs.nestapi.com/api-reference/account/revoke-an-api-key.md): Admin only. Cancels one of the account's keys. - [List the account's API keys](https://docs.nestapi.com/api-reference/account/list-the-accounts-api-keys.md): Admin only (an Admin API key or the account owner). Returns every key on the account with its type and fairness weight. - [Create an API key](https://docs.nestapi.com/api-reference/account/create-an-api-key.md): Admin only. Programmatically issue a key to one of your customers. Defaults to a Usage key; set KeyType=Admin to mint another admin key. Subject to the plan's active-key cap. - [Regenerate an API key](https://docs.nestapi.com/api-reference/account/regenerate-an-api-key.md): Admin only. Rotates one of the account's keys: cancels the old secret and issues a new one, carrying the key's reference, expiry, type, parallelism, fairness weight and allowed origins forward. The old key stops working immediately, so update integrations with the returned key. - [Set a key's Admin/Usage type](https://docs.nestapi.com/api-reference/account/set-a-keys-adminusage-type.md): Admin only. Change a key's capability class — e.g. downgrade a key you handed to a customer from Admin to Usage. - [Get your account profile](https://docs.nestapi.com/api-reference/account/get-your-account-profile.md): Get your account profile - [Check the expiry date of your ApiKey](https://docs.nestapi.com/api-reference/account/check-the-expiry-date-of-your-apikey.md): This endpoint requires calling with your Api Key.
If your Api key has an expiry it will return when it expires.
If your Api key does not expire, it will return 31/12/9999 as the expiry date. - [Validates the caller's API key is active and returns basic identity info](https://docs.nestapi.com/api-reference/account/validates-the-callers-api-key-is-active-and-returns-basic-identity-info.md): Validates the caller's API key is active and returns basic identity info - [Get your account's subscription status](https://docs.nestapi.com/api-reference/account/get-your-accounts-subscription-status.md): Returns your account's trial/payment state and current nesting balance. - [List allowed origins for an API key](https://docs.nestapi.com/api-reference/account/list-allowed-origins-for-an-api-key.md): List allowed origins for an API key - [Add an allowed browser Origin (CORS) to an API key. Provide a full absolute origin — scheme, host and (non-default) port — e.g. https://app.example.com. Origins are matched exactly, so register each distinct origin you call the API from. For local development, add your dev server's localhost origin (e.g. http://localhost:3000); the scheme and port must match exactly (http://localhost:3000 is different from https://localhost:3000 and from http://localhost:5173).](https://docs.nestapi.com/api-reference/account/add-an-allowed-browser-origin-cors-to-an-api-key-provide-a-full-absolute-origin-—-scheme-host-and-non-default-port-—-eg-https:appexamplecom-origins-are-matched-exactly-so-register-each-distinct-origin-you-call-the-api-from-for-local-development-add-your-dev-servers-localhost-origin-eg-http:localhost:3000;-the-scheme-and-port-must-match-exactly-http:localhost:3000-is-different-from-https:localhost:3000-and-from-http:localhost:5173.md): Add an allowed browser Origin (CORS) to an API key. Provide a full absolute origin — scheme, host and (non-default) port — e.g. https://app.example.com. Origins are matched exactly, so register each distinct origin you call the API from. For local development, add your dev server's localhost origin… - [Remove an allowed origin from an API key](https://docs.nestapi.com/api-reference/account/remove-an-allowed-origin-from-an-api-key.md): Remove an allowed origin from an API key - [Get the account's per-customer fairness configuration](https://docs.nestapi.com/api-reference/fairness/get-the-accounts-per-customer-fairness-configuration.md): Admin only. Returns whether fairness/overage are enabled, the default per-key weight, and the shared-burst percentage for the account's active plan. - [Update the account's per-customer fairness configuration](https://docs.nestapi.com/api-reference/fairness/update-the-accounts-per-customer-fairness-configuration.md): Admin only. Only the fields you supply are changed. Fairness is a paid-plan feature. See NESTING_MINUTES_FAIRNESS_DESIGN.md. - [Set a key's fairness weight](https://docs.nestapi.com/api-reference/fairness/set-a-keys-fairness-weight.md): Admin only. Sets the per-customer fairness weight for one of your keys; omit LineageWeight (null) to clear the override and fall back to the plan default. - [Per-customer nesting-minutes usage breakdown](https://docs.nestapi.com/api-reference/fairness/per-customer-nesting-minutes-usage-breakdown.md): Admin only (an Admin API key or the account owner). Returns how the account's nesting minutes are being shared across your API keys for the current period. Each row is one of your keys (i.e. one of your customers): the minutes it has consumed, its guaranteed fair-share floor, any overage it incurred… - [Fetch nests that have been completed successfully in the last 24 hours](https://docs.nestapi.com/api-reference/nesting/fetch-nests-that-have-been-completed-successfully-in-the-last-24-hours.md): Fetch nests that have been completed successfully in the last 24 hours - [Fetch nests that have been failed in the last 24 hours](https://docs.nestapi.com/api-reference/nesting/fetch-nests-that-have-been-failed-in-the-last-24-hours.md): Fetch nests that have been failed in the last 24 hours - [Get the status of a nesting request by RequestId](https://docs.nestapi.com/api-reference/nesting/get-the-status-of-a-nesting-request-by-requestid.md): Returns the current status (Queued, Running, Completed, Failed) and the ResultIdentity if available. - [Request a Render response for a nesting Result](https://docs.nestapi.com/api-reference/nesting/request-a-render-response-for-a-nesting-result.md): This endpoint requires calling with your ApiKey
RequestId

RequestId to get result from
ResultIdentity
ResultId for the result you wish to fetch
- [Request a ReportSource response for a nesting Result](https://docs.nestapi.com/api-reference/nesting/request-a-reportsource-response-for-a-nesting-result.md): This endpoint requires calling with your ApiKey
RequestId

RequestId to get result from
ResultIdentity
ResultId for the result you wish to fetch
- [NestingRequest based on parametric part definitions.](https://docs.nestapi.com/api-reference/nesting/nestingrequest-based-on-parametric-part-definitions.md): This endpoint requires calling with your ApiKey
Request
ParametricNestingRequest
Refer to Model link in body section of this endpoint's api doc below (Next to Example Value)
ResultsWebhookUri
Web hook uri to POST the result to - [NestingRequest based on Encoded geometry (from our importer or defined as SimpleGeometry).](https://docs.nestapi.com/api-reference/nesting/nestingrequest-based-on-encoded-geometry-from-our-importer-or-defined-as-simplegeometry.md): This endpoint requires calling with your ApiKey
Request
GeometryNestingRequest
Refer to Model link in body section of this endpoint's api doc below (Next to Example Value)
ResultsWebhookUri
Web hook uri to POST the result to - [MyNesting XML encoded request](https://docs.nestapi.com/api-reference/nesting/mynesting-xml-encoded-request.md): This endpoint requires calling with your ApiKey
Request
MyNestingXML
Refer to Model link in body section of this endpoint's api doc below (Next to Example Value)
ResultsWebhookUri
Web hook uri to POST the result to - [QuoteNestingRequest](https://docs.nestapi.com/api-reference/nesting/quotenestingrequest.md): This endpoint requires calling with your ApiKey
- [QuoteNestingRequest](https://docs.nestapi.com/api-reference/nesting/quotenestingrequest-1.md): This endpoint requires calling with your ApiKey
- [1D Nesting Request](https://docs.nestapi.com/api-reference/nesting/1d-nesting-request.md): This endpoint requires calling with your ApiKey
Returns a RequestId. Poll /nesting/status and, once it reports Completed, fetch the cutting plan from /nesting/1D/result — or supply a ResultsWebhookUri to be called instead. A rejected request returns the standard … - [Call this to start nesting in nesting ui once you have connected to signal R and invoked ListenForUpdates](https://docs.nestapi.com/api-reference/nesting/call-this-to-start-nesting-in-nesting-ui-once-you-have-connected-to-signal-r-and-invoked-listenforupdates.md): This endpoint requires calling with your ApiKey

Call this to start nesting in nesting ui once you have connected to signal R and invoked ListenForUpdates - [Advance a quote nest to the next sub-nest](https://docs.nestapi.com/api-reference/nesting/advance-a-quote-nest-to-the-next-sub-nest.md): This endpoint requires calling with your ApiKey

Stops the in-progress nest for this RequestId early and lets the server release the next one. This is the classic interactive 'continue to next nest' — only meaningful for a running quote nest. - [Get v1nestingexportquotenest](https://docs.nestapi.com/api-reference/nesting/get-v1nestingexportquotenest.md) - [Request a response for a nesting Result based on ResponseType passed](https://docs.nestapi.com/api-reference/nesting/request-a-response-for-a-nesting-result-based-on-responsetype-passed.md): This endpoint requires calling with your ApiKey

Id
String
This Id is NestIdentifier in the JSON pushed to your webhook for nesting. It is also returned from the /nesting endpoint

ResultId
String
This Id is ResultIdentity in the… - [NestingRequest based on geometry imported from the provided base64 encoded files.](https://docs.nestapi.com/api-reference/nesting/nestingrequest-based-on-geometry-imported-from-the-provided-base64-encoded-files.md): This endpoint requires calling with your ApiKey
Request
Base64NestingRequest
Refer to Model link in body section of this endpoint's api doc below (Next to Example Value)
ResultsWebhookUri
Web hook uri to POST the result to - [Fetch a cached nesting export generated via SignalR result generation request](https://docs.nestapi.com/api-reference/nesting/fetch-a-cached-nesting-export-generated-via-signalr-result-generation-request.md): Fetch a cached nesting export generated via SignalR result generation request - [1D Nesting Result](https://docs.nestapi.com/api-reference/nesting/1d-nesting-result.md): This endpoint requires calling with your ApiKey
Available once /nesting/status reports Completed for the RequestId. The plan is in Result with Status Success; a nest that ran but produced nothing reports Status Failure and a StatusReport. - [Endpoint to check if the api is alive](https://docs.nestapi.com/api-reference/public/endpoint-to-check-if-the-api-is-alive.md): Endpoint to check if the api is alive ## OpenAPI Specs - [openapi](https://docs.nestapi.com/openapi.json)