Quickstart

Five minutes from a key to a draft guide. You need a Sceniq creator account.

1. Make a key

In the studio, open Settings, API keys and make a key. Pick the scope:

• Read and write for building and editing guides. This is what agents need.
• Read only for reports and checks.
• Read, write and publish only if the agent should also publish changes to a guide that is already live, and only when you ask it to.

The key is shown once. Keep it in an environment variable, never in a prompt or a file you share:

export SCENIQ_API_KEY="sk_sceniq_YOUR_KEY"

2. Ask who the key belongs to

curl https://sceniq.earth/api/v1/me \
  -H "Authorization: Bearer $SCENIQ_API_KEY"

The answer names the creator, the key's scopes, the request limits and every endpoint. whoami has the full response.

3. List your guides

curl https://sceniq.earth/api/v1/guides \
  -H "Authorization: Bearer $SCENIQ_API_KEY"

Each guide carries its productId, which every guide operation takes.

4. Create a draft guide

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"}'

The guide starts as a draft that nobody else sees. Add spots with create_spot, group them with create_chapter, then run get_guide_readiness to see what is left before it can go on sale.

5. Let an agent do the rest

Most creators do not call the API by hand. Connect an agent and ask it to build the guide from your notes; it follows the authoring guide Sceniq hands every agent.