> ## Documentation Index
> Fetch the complete documentation index at: https://docs.widgety.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Widgety API

> Cruise data for your own website and systems.

export const OtherProducts = ({hide}) => <div>
    <p><strong>Looking for a different Widgety product?</strong></p>
    <ul>
      {hide !== 'connector' && <li><a href="/connector">AI Connector (MCP)</a> — Widgety inside Claude, Copilot or another AI assistant.</li>}
      {hide !== 'assistant' && <li><a href="/assistant">Widgety AI Assistant</a> — Widgety's own cruise assistant, in your browser.</li>}
      {hide !== 'api' && <li><a href="/api">Widgety API</a> — cruise data for your own website and systems.</li>}
      <li><a href="/which-product">Compare all three</a> — which one is right for me?</li>
    </ul>
  </div>;

<Info>
  You're in the **Widgety API** docs, for developers. Not building anything? [AI Connector](/connector) and [Widgety AI Assistant](/assistant) need no development work. [Compare the products](/which-product).
</Info>

The Widgety API gives you direct access to cruise content: ships, cabins, itineraries, deck plans, imagery, pricing and availability.

Use it when you're building something of your own. For cruise data inside an AI assistant, the [AI Connector](/connector) does that with no development work.

## Getting access

You need an **application ID** and **application token**. Request them from Widgety with some detail about your company, and your key is created with the cruise line operators you need unlocked.

To add operators later, contact support.

## The basics

| | |
| - | - |
| Base URL | `https://www.widgety.co.uk/api/` |
| Protocol | HTTPS only. HTTP requests are redirected. |
| Formats | JSON or XML, chosen by the file extension: `ships.json` or `ships.xml` |
| Auth | `app_id` and `token` on each request |
| Permissions | Operators are unlocked per key |

## Try it in Postman

The full API documentation includes a Postman collection. Import it, add your app ID and token as an environment, and you can explore every endpoint without writing code.

<Card title="Full API reference" icon="arrow-up-right-from-square" href="https://developer.widgety.co.uk/" horizontal>
  Endpoints, parameters, examples and the Postman collection.
</Card>

## Coming to these pages

We're bringing the API reference into this site, so all Widgety documentation lives in one place, with:

* An interactive console for trying endpoints from the page
* Worked examples: search, then sailing detail, then itinerary
* Guidance on rate limits, pagination and content levels

***

<OtherProducts hide="api" />