Planimble for developers

Playground

Everything here calls this Planimble server for real: . Work through the steps in order, and watch the sketcher and its messages on the right.

Try the API

No key yet? Check the public API here without leaving the playground.

How do I get an API key?

There is no separate sandbox or test-key service. Authenticated requests use a pk_live_… key and operate on real account data. API access requires an active B2B API plan.

  1. Sign in to Planimble in a new tab as the account owner, then return here. Signing in opens the sketch app; it does not run an API test.
  2. Choose Prepare key request below. This fills the API console with POST /api/v1/org/api-keys and owner-session authentication; it does not create a key yet.
  3. Review the request and click Send request. Copy the apiKey from the response into step 1. It is shown only once; store it securely.

A live key accesses the account's sketches. Use separate sample inspection IDs when testing. Without a B2B account, use the public API check or download sample data.

Read about keys and tokens

1 Connect your API key

Not connected

Your key stays in this tab's memory. In production it lives only on your server; this page plays your server.

2 Allow this page to embed

Not checked

Only websites the account owner registers can show the sketcher. To try it here, register . You need to be signed in to Planimble in this browser as the owner of the B2B account.

3 Put a sketch on the server optional

Skipped

Your system can send a sketch before the inspector opens it, for example from a previous inspection. Skip this to start with an empty sheet.

4 Open the sketcher

Closed

Your server asks for a link for one inspection; your page mounts it with the SDK. The link works for two hours and only on this website.

Mode

5 Read the result

Not read

After the inspector saves, your server reads the sketch by its inspection ID. Planimble recalculates every area itself, so these numbers can be trusted.

API console

Call any endpoint. Each request is shown as curl, C# and Node so you can copy it into your own code.

Response

Not sent
Send a request to see the response.