SceniqDevelopers

set_guide_region

Set the map region (label, center, zoom, bbox).

PUT/v1/guides/{productId}/region
MCP tool set_guide_regionScope: writeStableSince 2026-09-17
Markdown

Full replacement of the map region the viewer opens on. Use a label buyers recognise (Yellowstone and Grand Teton), the center of the spots, a zoom of 8-11 for a region, and a bbox [west, south, east, north] that contains every spot.

curl -X PUT "https://sceniq.earth/api/v1/guides/j5738kd1q9x2m7v4c6b8n0p3r5t1w9y2/region" \
  -H "Authorization: Bearer $SCENIQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "region": {
    "label": "Yellowstone and Yosemite",
    "centerLat": 41.2,
    "centerLon": -115,
    "defaultZoom": 5,
    "bbox": [
      -120,
      37.4,
      -109.8,
      45.2
    ]
  }
}'

Path parameters

Body parameters

  • regionMapRegionrequired

    Object with label, centerLat, centerLon, defaultZoom (0-22) and bbox [west, south, east, north].

    Show 5 fieldsof MapRegion
    • labelstringoptional

      A name buyers recognise for the region, at most 120 characters (Hokkaido, the Dolomites).

    • centerLatnumberoptional

      Latitude of the opening center (-90 to 90), usually the middle of the spots.

    • centerLonnumberoptional

      Longitude of the opening center (-180 to 180).

    • defaultZoomnumberoptional

      The opening zoom level, 0 to 22; 8 to 11 suits a region.

    • bboxarray of numbersoptional

      The bounding box as [west, south, east, north] in decimal degrees, exactly four numbers. It should contain every spot: readiness flags spots outside it.

Returns

200 OK with this object.

  • okbooleanrequired

    Always true: the write went through.

    Always true

  • productIdstring · guide idrequired

    The guide's id.

  • regionMapRegionrequired

    The region as sent.

    Show 5 fieldsof MapRegion
    • labelstringoptional

      A name buyers recognise for the region, at most 120 characters (Hokkaido, the Dolomites).

    • centerLatnumberoptional

      Latitude of the opening center (-90 to 90), usually the middle of the spots.

    • centerLonnumberoptional

      Longitude of the opening center (-180 to 180).

    • defaultZoomnumberoptional

      The opening zoom level, 0 to 22; 8 to 11 suits a region.

    • bboxarray of numbersoptional

      The bounding box as [west, south, east, north] in decimal degrees, exactly four numbers. It should contain every spot: readiness flags spots outside it.

Response 200
{
  "ok": true,
  "productId": "j5738kd1q9x2m7v4c6b8n0p3r5t1w9y2",
  "region": {
    "label": "Yellowstone and Yosemite",
    "centerLat": 41.2,
    "centerLon": -115,
    "defaultZoom": 5,
    "bbox": [
      -120,
      37.4,
      -109.8,
      45.2
    ]
  }
}

Errors

Every error is { error: { code, message } }. Act on the code.

  • 400invalid_argumentA 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).
  • 400invalid_requestA 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.
  • 401unauthenticatedThe request carries no key. Send it as Authorization: Bearer sk_sceniq_... (or X-Api-Key).
  • 401invalid_api_keyThe key is unknown, revoked or expired.
  • 403api_scope_requiredA read-only key called a write operation, or a key without the publish option called publish_changes.
  • 403forbiddenThe key belongs to a creator account that is no longer active.
  • 404not_foundThe id does not exist or belongs to another creator. The two answers are identical on purpose, so ids never reveal what exists.
  • 413payload_too_largeA JSON body over 2 MB, an image over 6 MB, a batch upload over 19 MB, or an MCP message over 2 MB.
  • 429rate_limitedOver a limit: requests per key per minute, per creator per hour, uploads per key per minute, or check_links per guide per hour.
  • 500internal_errorAn unexpected failure. The message is hidden on purpose.