Quickstarts

Each quickstart takes the same path, so you can switch between them without relearning anything: authenticate, confirm the token, list canvases, read one graph, validate a change for free, then apply it.

None of them spend provider credit. Generation is deliberately left to Generate and observe an image, where the cost is the point of the page.

Pick one

Quickstart	Use it when
cURL	You want to see the wire format with nothing in between — the best first read even if you will ship in another language
TypeScript	You are building a Node or edge integration. Plain `fetch`, no dependencies, copy-pasteable.
CLI	You want results in a terminal, or a fast way to poke at the API — including `gavana api` for raw passthrough calls

What you need first

An Agent Access token

Create one in Gavana — see Create an Agent Access token. For these quickstarts select canvas:read and canvas:write; that is enough for everything here and nothing more.

The token is shown once. Put it somewhere your shell can read without echoing it, and never paste it into a URL, a log, or a chat.

It in an environment variable


read -rs 'GAVANA_AGENT_TOKEN?Paste Agent Access token: '; printf '\n'
export GAVANA_AGENT_TOKEN

read -rs in zsh (and read -rsp in bash) keeps the token out of shell history and out of the process list.

The base URL


https://app.gavana.ai/api/canvas-agent/v1

The OpenAPI document declares the server as the relative path /api/canvas-agent/v1, so the full base is that path on the Gavana origin you use.

The shape of every call

Whichever quickstart you pick, the request never varies much:


POST /api/canvas-agent/v1/canvases/product-launch/operations HTTP/1.1
Host: app.gavana.ai
Authorization: Bearer cba_<token-id>.<secret>
Content-Type: application/json
Accept: application/json

And the response always carries a correlation id:


HTTP/1.1 200 OK
Content-Type: application/json
X-Request-ID: 8c1f2d34-5a6b-4c7d-8e9f-0a1b2c3d4e5f

Capture X-Request-ID from the start. It is the only thing you can safely share with support, and it is the only diagnostic you get on a 5xx.

Where to go after

Platform — the six mechanisms every call depends on
Recipes — complete worked tasks, including paid ones
Resources — the generated per-operation contract