canonical: https://jentic.com/apis/getarbo.com/getarbo

# Getarbo Arbo API

The Arbo API builds and manages a project's visual sitemap, the tree of pages that describes a website's structure. An agent reads a project and its pages, adds a page, updates one page or many at once in bulk, and imports a whole sitemap tree in a single call. It lists version snapshots of the sitemap, polls async jobs, and reads a review that carries each page's status, version, and Figma link along with the comments pinned to a version and breakpoint. Responses are JSON and authentication is a bearer token.

## For AI agents

Build and manage a project's visual sitemap tree: add, update, bulk-edit, and import pages, list version snapshots, and read per-page review status and comments. Authenticates with a bearer token.

## Scope

Does not handle website hosting, content publishing, or SEO analytics. Use for building and managing visual sitemaps only.

## Capabilities

- Add a page to a project's sitemap tree
- Update a single page or bulk-update many pages at once
- Import a full sitemap tree into a project in one call
- List version snapshots of a project's sitemap
- Read a project's review with per-page status, version, and Figma link
- Pull review comments pinned to a version and breakpoint
- Poll the status of an async sitemap job

## Use cases

### Agent-Built Sitemaps

An AI agent planning a website can call the Arbo API through Jentic to turn a page outline into a visual sitemap, adding each page to the project tree. The agent builds the structure without the developer wiring the bearer auth or the project and node paths by hand, and it can bulk-update pages as the plan changes. Jentic returns the matching operation and its input schema so the agent edits the sitemap inline.

Example prompt: Add a page to a project's sitemap for each section of a site outline and return the resulting tree

### Bulk Sitemap Import and Editing

A tool migrating or restructuring a site can import a whole sitemap tree in one call rather than adding pages one by one, then bulk-update many pages together. Arbo imports a full tree, updates multiple pages in a single bulk request, and exposes an async job to poll while a large import completes.

Example prompt: Import a sitemap tree into a project, then bulk-update the labels on several pages and poll the import job until it finishes

### Review Status and Comments

A design handoff can track where each page stands by reading its review status, version, and linked Figma design, and the comments reviewers pinned to a version and breakpoint. Arbo returns the per-page review and its comments, so a workflow can surface which pages are approved and which still have open feedback.

Example prompt: Read a project's review and list the pages that still have open review comments

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/api/v1/projects/{id}/nodes` | Add a page to the sitemap |
| GET | `/api/v1/projects/{id}/nodes` | List all active pages |
| PUT | `/api/v1/projects/{id}/nodes/{nid}` | Update a page |
| PATCH | `/api/v1/projects/{id}/nodes/bulk` | Update multiple pages at once |
| POST | `/api/v1/projects/{id}/import` | Import a full sitemap tree |
| GET | `/api/v1/projects/{id}/history` | List version snapshots |
| GET | `/api/v1/projects/{id}/review` | Review status, version, and Figma link per page |

## Key resources

- **Projects** — Read a project and its full set of pages.
- **Nodes** — Add, read, update, bulk-update, and remove pages in a project's sitemap tree.
- **Import and History** — Import a full sitemap tree and list the project's version snapshots.
- **Review** — Read per-page review status, version, and Figma link along with pinned comments.
- **Jobs** — Poll the status of an async sitemap job.

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 59 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 58 / 100
  - AI-Readiness & Agent Experience: 44 / 100
  - Agent Usability: 94 / 100
  - Security: 60 / 100
  - AI Discoverability: 39 / 100
- **View full report:** https://jentic.com/apis/getarbo.com/getarbo/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring Arbo by hand means handling its bearer token, threading the project and node ids through each path, and polling the async job endpoint while a large import completes. Through Jentic you install once, import Arbo from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Arbo puts the project id in the URL path, so a rule can pin your agent to one project and the operations you pick on it. You choose which operations it may call, so page removal is not included unless you add it.
- **Credential handling:** Your Arbo token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'add a page to a sitemap' or 'import a sitemap tree', and Jentic returns the matching Arbo operation with its input schema so the agent calls the right endpoint directly.

## Related APIs

- **Miro API** — Builds visual boards with shapes, connectors, and frames for mapping structure.
- **Figma REST API** — Reads design files and posts comments on frames and components.
- **Atarim API** — Collects visual tasks and comments pinned to pages of a website.

## FAQ

### What authentication does the Arbo API use?

The Arbo API authenticates with a bearer token on its project operations, per its OpenAPI spec, while a health-check operation is open. Through Jentic the token is stored once, encrypted, by your own Jentic One instance and injected at call time, so it never reaches the agent's prompt or logs.

### Is there an Arbo MCP server?

You don't need an MCP server to give your agent the Arbo API. Jentic connects it directly from the API Directory: import it, store your token once, and your agent can build and edit sitemaps straight away.

### Can I limit what my agent is allowed to do with the Arbo API?

Yes. Arbo puts the project id in the URL path, so a rule can bound your agent to one project and the operations you pick on it. Allow it to add pages and read reviews but leave page removal out unless you add it, and every call it makes is logged.

### Can I import a full sitemap into a project with the Arbo API?

Yes. The import operation takes a whole sitemap tree and loads it into a project in one call, and an async job operation lets an agent poll until a large import finishes rather than adding pages individually.

### What are the rate limits for the Arbo API?

The OpenAPI spec does not publish a numeric rate limit for the Arbo API. Check the Arbo documentation for the current limits on your plan.

### How do I add a page to a sitemap with the Arbo API through Jentic?

Search Jentic for an intent like 'add a page to a sitemap' and it returns the Arbo add-page operation with its input schema, so your agent sends the page details and reads back the updated tree. To run it on your own infrastructure, install Jentic One from its GitHub repo.
