API Reference

The Charter Boats API is organized by who's calling:

• Discovery API (/api/ai/*) — public, no key. Conversational search for guests, AI assistants, and agents (also via MCP / Custom GPT).
• Agent API (/api/agent/*) — for approved charter agents. Reveals platform, deeplinks, and per-week activity the public search hides. Needs a logged-in agent session.
• Operator API — for owners and partners managing their own listings (boats, pricing, fees, calendar). Writes need a key.
• Places & Data — public reference data anyone can read (locations, POIs, passages, sea routing, conditions).

Base URL

https://charter.boats/api

Authentication

The Discovery API and all read endpoints are open to server-side callers — no key needed for curl or a backend. Only the two write actions (POST /import/boat, DELETE /boats/:id) require your key in the X-API-Key header:

curl -X POST "https://charter.boats/api/import/boat" \
  -H "X-API-Key: cb_live_your_api_key_here" \
  -d '{ ... }'

Generate your key from Dashboard → Settings → API. See Authentication for the full rules (including the cross-origin browser case).

Response Format

Endpoints return data directly as JSON. Error responses include a status code and message:

{
  "statusCode": 400,
  "message": "Error description"
}

Discovery API · guests & agents

Public, no key. Compact, fuzzy-matched results tuned for conversation. See the overview.

Agent API · approved agents

Agent-authenticated search that reveals source platform, per-yacht deeplinks, per-week availability/options, and a commission preview. Requires a logged-in agent session — see the overview.

Operator API · owners & partners

Manage your own listings.

Boats

Pricing & Fees

Calendar

Places & Data · public reference

Read-only catalog data anyone can use to build on the platform.

Locations & POIs

Passages & Sea Routing

Conditions

Looking for booking or content endpoints?

• Booking a boat (reserve + pay) runs through the charter.boats checkout UI, not a public API -- it needs a logged-in guest session and Stripe Elements on the page.
• Articles & FAQs are searchable via the Discovery API's /ai/content.

HTTP Status Codes