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

# boomurl Publishing API

The boomurl Publishing API publishes static websites and returns an instant public URL. An agent mints a bearer API key after email verification, then creates or updates a site with a single idempotent request. It also lists and reads the sites a key owns, attaches apex or subdomain custom domains, and tracks nameserver delegation and TLS readiness for each domain.

## For AI agents

Publish static sites and get a public URL, mint and revoke API keys, and attach custom domains with delegation and TLS status. Returns JSON over a bearer-authenticated REST API with public key-bootstrap endpoints.

## Scope

Does not build or compile source code, run servers, or store databases. Use for publishing static sites and managing their custom domains only.

## Capabilities

- Publish or update a static website with a single idempotent request
- Mint and revoke bearer API keys after email verification
- List and read the status and public URL of the sites a key owns
- Attach apex or subdomain custom domains to a site
- Track custom-domain nameserver delegation and TLS readiness
- Delete a site or disconnect a custom domain

## Use cases

### AI Agent Site Publishing via Jentic

An agent that generates a web page or report can publish it with boomurl through Jentic without wiring the bearer key or walking the email-verification bootstrap. The agent searches by intent, receives the operation schema, and publishes a site to get a public URL back. This fits agents that produce a document and need to share it at a live address.

Example prompt: Search Jentic for 'publish a static site', load the operation schema, and publish the files to get a public URL

### Static Site Publishing

Push static files and get an instant public URL. boomurl creates or updates a site with one idempotent request, so an agent can republish on each change without tracking whether the site already exists, and read the site's status and URL afterward.

Example prompt: Call PUT `/api/v1/sites/{name}` to publish a static site and receive its public URL

### Custom Domain Management

Put a published site on your own domain. boomurl attaches an apex or subdomain to a site and reports nameserver delegation and TLS readiness, so an agent can wire up a custom domain and poll until it is live, then disconnect it when no longer needed.

Example prompt: Call POST `/api/v1/sites/{name}/domains` to attach a custom domain, then GET `/api/v1/sites/{name}/domains/{domain}` to check TLS readiness

### Site Lifecycle Management

Keep a key's set of sites tidy. boomurl lists the sites a key owns, reads one site's status, and deletes a site when it is retired, so an agent managing many short-lived pages can clean up after itself.

Example prompt: Call GET `/api/v1/sites` to list your sites, then DELETE `/api/v1/sites/{name}` to remove one

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/api/v1/keys/request` | Email a code to begin minting a key |
| POST | `/api/v1/keys` | Confirm the code and mint an API key |
| GET | `/api/v1/sites` | List the sites owned by your key |
| PUT | `/api/v1/sites/{name}` | Create or update a site (idempotent) |
| GET | `/api/v1/sites/{name}` | Get site status and public URL |
| DELETE | `/api/v1/sites/{name}` | Delete a site you own |
| POST | `/api/v1/sites/{name}/domains` | Attach a custom domain to a site |
| GET | `/api/v1/sites/{name}/domains/{domain}` | Status of one custom domain |

## Key resources

- **Keys** — Mint, list, and revoke bearer API keys after email verification
- **Sites** — Publish, list, read, and delete static sites and their public URLs
- **Domains** — Attach, list, read status for, and disconnect custom domains

## 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:** 68 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 61 / 100
  - AI-Readiness & Agent Experience: 51 / 100
  - Agent Usability: 94 / 100
  - Security: 60 / 100
  - AI Discoverability: 72 / 100
- **View full report:** https://jentic.com/apis/boomurl.com/boomurl/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 the boomurl API by hand means verifying your email to mint a bearer key, publishing with an idempotent PUT, and polling custom-domain delegation and TLS status yourself. Through Jentic you install once, import boomurl from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** boomurl puts the site name and domain in the URL path (`/api/v1/sites/{name}`, `/api/v1/sites/{name}/domains/{domain}`), so a rule can pin your agent to one site and the operations you pick. You choose the operations it may call, so destructive ones like deleting a site or revoking a key are not included unless you add them.
- **Credential handling:** Your boomurl API key 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 'publish a static site' or 'attach a custom domain', and Jentic returns the matching boomurl operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Netlify API** — Alternative static site hosting and deploys
- **Firebase Hosting API** — Alternative static and dynamic web hosting with custom domains
- **AppDeploy API** — Application build and deployment automation

## FAQ

### Is there a boomurl MCP server?

Yes, boomurl offers a hosted Model Context Protocol connector, and you can also connect it directly through Jentic from the API Directory: import it, store your bearer key once, and your agent publishes sites and manages domains without loading another server's tool definitions into its context.

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

Yes. The site name and domain sit in the URL path, so you write a rule that allows publishing and reading one site, and the agent can republish and check status while deleting a site or revoking a key stays out of reach. Every call is logged by your self-hosted instance.

### What authentication does the boomurl API use?

The boomurl API authenticates with a bearer API key, minted after email verification and sent in the Authorization header, per its OpenAPI spec. The key-request and key-mint endpoints are public and need no credential so an agent can bootstrap its first key. Through Jentic the key is stored encrypted by your own Jentic One instance and injected at call time.

### Can I attach a custom domain with the boomurl API?

Yes. Attach an apex or subdomain to a site, then read the domain's status to track nameserver delegation and TLS readiness. You can also disconnect a domain later.

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

The OpenAPI spec does not specify rate limits. Check the vendor's documentation at https://boomurl.com for current limits.

### How do I publish a static site with the boomurl API through Jentic?

Search Jentic for 'publish a static site' and it returns the boomurl publish operation with its input schema; the agent sends the files with one idempotent request and gets a public URL back. To run it on your own infrastructure, install Jentic One from its GitHub repo.
