Skip to main content

GET /api/sites/:slug/manifest

Returns the complete manifest for a site — the typed state machine with all states, views, and actions. This is the source of truth for everything the AI discovered.

Path parameters

slug
string
required
The site identifier (e.g., example-com). Use GET /api/sites to list available slugs.

Example

curl http://127.0.0.1:8787/api/sites/example-com/manifest

Manifest structure

FieldTypeDescription
idstringUnique manifest identifier
domainstringWebsite domain
originstringFull origin URL
slugstringURL-safe site identifier
statesarrayPage states, each with views and actions
Each state contains:
FieldTypeDescription
idstringUnique state identifier
namestringSemantic name (e.g., HomePage, LoginPage)
url_patternstringRFC 6570 URI template for navigating to this state
viewsarrayData extraction functions (name + code)
actionsarrayInteraction functions (name + inputs + code)

Error responses

StatusBody
404{ "error": "Not found" }
If you receive a 404, the site hasn’t been trained yet or the slug is incorrect. Check GET /api/sites for available slugs.