# create_guide

Create a new draft guide.

`POST /v1/guides` · MCP tool `create_guide` · scope `write` · stable · since 2026-09-17

Creates an empty draft map guide (status draft, not visible anywhere). Only do this when the creator asked for a new guide; otherwise edit the existing one. The slug derives from the name unless given.

## Body parameters

- `name` (string, required): Guide title, 1-120 characters, e.g. American West: Parks at First Light.
- `slug` (string, optional): Optional URL slug (lowercase letters, digits, hyphens). Derived from the name when omitted.

## Returns

201: Guide.

- `productId` (string, required): The guide's id.
- `name` (string, required): The guide's title.
- `slug` (string, required): URL slug of the sales page.
- `headline` (string or null, required): One-line promise under the title on the sales page.
- `purchaseButtonText` (string or null, required): The buy button label, or null for the default.
- `status` (string, required): draft (not on sale), published (on sale) or archived. One of `draft`, `published`, `archived`.
- `visibleOnStore` (boolean, required): Whether the guide shows in the Sceniq store (set in the studio).
- `storeReviewStatus` (string or null, required): The store review's state, or null before a review. One of `pending`, `approved`, `rejected`.
- `storeReviewNote` (string or null, required): The store review team's note.
- `storeTags` (array of strings, required): Store tags from the fixed vocabulary.
- `country` (string or null, required): ISO 3166-1 alpha-2 code of the country the guide covers; null means worldwide.
- `reviewsShown` (boolean, required): Whether buyer reviews show on the store card.
- `buyerCountShown` (boolean, required): Whether the buyer count shows on the sales page (set in the studio).
- `pricing` (object, required): How the guide is sold.
  - `oneTimeEnabled` (boolean, required): Whether the guide sells for a one-time price.
  - `subscriptionIncluded` (boolean, required): Whether it is part of a subscription.
  - `currency` (string, required): The guide's currency.
- `originalLanguage` (string, required): The language the guide is written in (BCP 47).
- `createdAt` (number, required): When the row was created (Unix time in milliseconds).
- `updatedAt` (number, required): When the row last changed (Unix time in milliseconds).
- `publishedAt` (number or null, required): When the guide first went on sale (Unix time in milliseconds).
- `lastApiWriteAt` (number or null, required): When a key last changed the guide (Unix time in milliseconds).
- `region` (MapRegion or null, required): The map region the viewer opens on.
  Fields of MapRegion: https://developers.sceniq.earth/fields/map-region.md
- `areas` (array of Area, required): Parks, islands and regions spots can point at.
  Fields of Area: https://developers.sceniq.earth/fields/area.md
- `mapStyle` (object or null, required): The map's style, set in the studio.
  - `basemap` (string, optional): The base map style.
  - `pinStyle` (string, optional): The pin style.
  - `themeColor` (string, optional): The accent color.
- `propertySchemaVersion` (number or null, required): Bumped on every property change.
- `properties` (array of Property, required): Custom property definitions.
  Fields of Property: https://developers.sceniq.earth/fields/property.md
- `price` (object or null, required): The active one-time price, or null when none is set.
  - `amountMinor` (number, required): The price in minor units (2900 is 29.00).
  - `currency` (string, required): ISO 4217 code in lower case (usd, eur, chf).
- `spotCount` (number, required): Number of spots, archived ones included.
- `thumbnailUrl` (string or null, required): The 4:5 store thumbnail.
- `dashboardUrl` (string, required): The guide in the studio.
- `salesPageUrl` (string, required): The public sales page (live once published).

## Examples

### Create a draft guide with your own slug

```bash
curl -X POST "https://sceniq.earth/api/v1/guides" \
  -H "Authorization: Bearer $SCENIQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "American West: Parks at First Light",
  "slug": "american-west-first-light"
}'
```

MCP `tools/call`:

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_guide",
    "arguments": {
      "name": "American West: Parks at First Light",
      "slug": "american-west-first-light"
    }
  }
}
```

Response 201:

```json
{
  "productId": "j5738kd1q9x2m7v4c6b8n0p3r5t1w9y2",
  "name": "American West: Parks at First Light",
  "slug": "american-west-first-light",
  "headline": null,
  "purchaseButtonText": null,
  "status": "draft",
  "visibleOnStore": false,
  "storeReviewStatus": null,
  "storeReviewNote": null,
  "storeTags": [],
  "country": null,
  "reviewsShown": true,
  "buyerCountShown": false,
  "pricing": {
    "oneTimeEnabled": true,
    "subscriptionIncluded": false,
    "currency": "usd"
  },
  "originalLanguage": "en",
  "createdAt": 1789895640000,
  "updatedAt": 1789895640000,
  "publishedAt": null,
  "lastApiWriteAt": null,
  "region": null,
  "areas": [],
  "mapStyle": null,
  "propertySchemaVersion": 1,
  "properties": [],
  "price": null,
  "spotCount": 0,
  "thumbnailUrl": null,
  "dashboardUrl": "https://creators.sceniq.earth/products/j5738kd1q9x2m7v4c6b8n0p3r5t1w9y2",
  "salesPageUrl": "https://sceniq.earth/mara-lindgren/american-west-first-light"
}
```

### Let the slug derive from the name

```bash
curl -X POST "https://sceniq.earth/api/v1/guides" \
  -H "Authorization: Bearer $SCENIQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Patagonia: Torres del Paine and Fitz Roy"
}'
```

MCP `tools/call`:

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_guide",
    "arguments": {
      "name": "Patagonia: Torres del Paine and Fitz Roy"
    }
  }
}
```

Response 201:

```json
{
  "productId": "j57mtnsxbtctmt4347jg8s8nrgbqhybg",
  "name": "Patagonia: Torres del Paine and Fitz Roy",
  "slug": "patagonia-torres-del-paine-and-fitz-roy",
  "headline": null,
  "purchaseButtonText": null,
  "status": "draft",
  "visibleOnStore": false,
  "storeReviewStatus": null,
  "storeReviewNote": null,
  "storeTags": [],
  "country": null,
  "reviewsShown": true,
  "buyerCountShown": false,
  "pricing": {
    "oneTimeEnabled": true,
    "subscriptionIncluded": false,
    "currency": "usd"
  },
  "originalLanguage": "en",
  "createdAt": 1790673240000,
  "updatedAt": 1790673240000,
  "publishedAt": null,
  "lastApiWriteAt": null,
  "region": null,
  "areas": [],
  "mapStyle": null,
  "propertySchemaVersion": 1,
  "properties": [],
  "price": null,
  "spotCount": 0,
  "thumbnailUrl": null,
  "dashboardUrl": "https://creators.sceniq.earth/products/j57mtnsxbtctmt4347jg8s8nrgbqhybg",
  "salesPageUrl": "https://sceniq.earth/mara-lindgren/patagonia-torres-del-paine-and-fitz-roy"
}
```

## Errors

- `invalid_argument` (400): A required field is missing, a field is unknown, or a value does not match its type (the Convex validator's path and value are in the message).
- `invalid_request` (400): A writer refused a value: a map link on a host that is not allowed, a title that is too long, a date that does not exist, too many items in a list. The message is the writer's own sentence.
- `unauthenticated` (401): The request carries no key. Send it as Authorization: Bearer sk_sceniq_... (or X-Api-Key).
- `invalid_api_key` (401): The key is unknown, revoked or expired.
- `api_scope_required` (403): A read-only key called a write operation, or a key without the publish option called publish_changes.
- `forbidden` (403): The key belongs to a creator account that is no longer active.
- `payload_too_large` (413): A JSON body over 2 MB, an image over 6 MB, a batch upload over 19 MB, or an MCP message over 2 MB.
- `rate_limited` (429): Over a limit: requests per key per minute, per creator per hour, uploads per key per minute, or check_links per guide per hour.
- `internal_error` (500): An unexpected failure. The message is hidden on purpose.

Reference: https://developers.sceniq.earth/reference/create_guide