Magicplan App magicplan Cloud API

Name: magicplan Cloud API
Brand: magicplan Cloud API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentProductivityCollaborationapiKey28 EndpointsREST

For Agents

Manage magicplan workspaces, projects, plans, forms and estimates through 28 Cloud endpoints aimed at field teams capturing floor plans and site data.

Install Jentic One Beta

Connect the magicplan Cloud API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the magicplan Cloud API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with magicplan Cloud API.

Manage workspace settings and invite members via /workspace endpoints

Create and update teams plus their memberships through /teams and /teams/{id}/members

Run full project lifecycle operations including create, archive and restore via /projects endpoints

GET STARTED

Start building with magicplan Cloud API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use magicplan Cloud API for, with concrete tasks.

★ Field Team Project Provisioning

Spin up a magicplan project before a technician heads into the field. POST /projects creates the project record, POST /workspace/members/invite adds any temporary contractors, and POST /teams/{id}/members assigns the technician to the right team. Suitable for dispatch or scheduling tools that need to pre-stage projects so field captures sync straight into the right workspace.

POST /projects with the customer address, then POST /teams/{id}/members to assign the on-site technician

Floor Plan and Photo Upload Pipeline

Sync large floor-plan files and site photos from a mobile capture tool into the magicplan cloud. The agent first calls POST /projects/{id}/files/temporary-presigned-url to obtain a temporary upload URL, uploads the asset directly to that URL, then calls POST /projects/{id}/files to register the uploaded artefact. GET /projects/{id}/files lists the files and DELETE /projects/{id}/files/{fileId} removes obsolete uploads.

Request a presigned URL via POST /projects/{id}/files/temporary-presigned-url, upload the floor plan, then call POST /projects/{id}/files to register it

Estimate and Plan Reporting

Pull out the financial and structural deliverables once a project finishes. GET /projects/{id}/estimates lists every estimate generated from the project's plan, GET /projects/{id}/estimates/{estimateId} fetches the detail, and GET /plans/get/{id} returns the underlying plan record. Useful for finance teams reconciling invoices against the field-captured data.

Iterate GET /projects/{id}/estimates, fetch each estimate via GET /projects/{id}/estimates/{estimateId}, and assemble a finance report

Forms-Based Inspection Capture

Configure structured field data capture by deploying magicplan forms across projects. POST /forms creates a new form template, GET /plans/forms/{id} returns the forms attached to a plan, and PUT /forms/{id} amends questions on the fly. Suitable for restoration and inspection companies that need consistent, structured site reports rather than free-form notes.

POST /forms with the inspection template, then GET /plans/forms/{id} to confirm it is attached to the active plan

AI Agent Field Operations

Let an AI dispatcher orchestrate magicplan field operations end-to-end without holding the workspace API key. Through Jentic the agent searches for the project, file, plan or form operation it needs, loads the schema, and executes with credentials brokered by the vault. Useful for restoration coordinators and contractor desks that want a single agent to manage many parallel jobs.

Search Jentic for 'create a magicplan project', load POST /projects, and execute with the customer's site address from the dispatch system

Key Endpoints

28 endpoints — jentic publishes the only available openapi specification for magicplan cloud api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/projects

Create a new project

POST

/projects/{id}/files/temporary-presigned-url

Request a presigned upload URL

POST

/projects/{id}/files

GET

/projects/{id}/estimates

List project estimates

POST

/forms

Create a form template

POST

/teams

Create a team

POST

/workspace/members/invite

Invite workspace members

POST

/plans/{id}/custom-export

Trigger a custom plan export

POST

/projects

Create a new project

POST

/projects/{id}/files/temporary-presigned-url

Request a presigned upload URL

POST

/projects/{id}/files

GET

/projects/{id}/estimates

List project estimates

POST

/forms

Create a form template

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

magicplan API keys (workspace and customer scopes) are stored encrypted in the Jentic vault (MAXsystem). Agents receive scoped access tokens — the raw keys never enter the agent's context, so prompt leakage cannot expose the underlying credential.

Intent-based discovery

Agents search by intent (e.g. 'create a magicplan project' or 'upload a floor plan') and Jentic returns the matching /projects, /projects/{id}/files or /forms operation along with its input schema, so the agent picks the right call without browsing apidocs.magicplan.app.

Time to first call

Direct magicplan integration: 3-5 days to wire dual-scope auth, presigned upload flow and 28-endpoint schema. Through Jentic: under 2 hours — search, load schema, execute.

FAQs

Specific to using magicplan Cloud API through Jentic.

Why is there no official OpenAPI spec for magicplan Cloud API?

magicplan publishes documentation at apidocs.magicplan.app but does not ship a curated OpenAPI specification. Jentic generates and maintains this spec so AI agents and developers can call the magicplan Cloud API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the magicplan Cloud API use?

The API uses two API key schemes — apiKeyAuth for workspace-level keys and customerAuth for customer-scoped tokens — passed in request headers. Through Jentic the credentials are stored encrypted in the MAXsystem vault, so an agent calls /projects or /forms with a scoped token rather than handling raw keys.

How do I upload a floor plan file via the magicplan Cloud API?

Use the two-step presigned URL flow. POST /projects/{id}/files/temporary-presigned-url returns a short-lived upload URL, you upload the binary directly to that URL, then POST /projects/{id}/files registers the uploaded artefact against the project. GET /projects/{id}/files confirms the file appears in the project record.

What are the rate limits for the magicplan Cloud API?

Per-endpoint rate limits are not declared in the OpenAPI spec; magicplan typically applies workspace-level fair-use ceilings agreed at contract level. For high-volume sync workloads such as restoration fleets, coordinate with magicplan on dedicated quota.

How do I create a new magicplan project through Jentic?

Run pip install jentic, search for 'create a magicplan project', and Jentic surfaces POST /projects with its input schema. Execute with the project name and site address fields, then chain to POST /workspace/members/invite if a temporary contractor needs access.

Can the magicplan Cloud API export a plan to a custom format?

Yes. POST /plans/{id}/custom-export triggers a custom export job for the specified plan, and GET /images/plan/{id}/svg/{fileName} returns rendered SVG assets attached to the plan. Combine the two to build a finance-friendly report once the field capture finishes.

Magicplan App magicplan Cloud API

Connect the magicplan Cloud API to your agent

Capabilities

Start building with magicplan Cloud API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs