Skip to page content
Proof Docs

Projects

A Project holds a website, Environments, mapping sessions, tests, and results.

Create a Project

Enter a website URL on Projects and select Continue. Proof creates the Project and its default Environment. A GitHub connection is not required.

Project creation requires owner or administrator access and a request from the Proof site. The dashboard endpoint uses a browser session, not an API key.

POST /api/dashboard/projects accepts this JSON body:

json
{"name":"Storefront","url":"https://storefront.example.com"}

Success returns 201 with id andhref. Invalid input returns 400, missing sign-in returns 401, and denied access or cross-site requests return 403. A 500 can follow a saved Project whose response failed. Inspect Projects before retrying.

Map and review

Select an Environment and start mapping. Review proposed cases, expected results, evidence, and action permissions before confirmation.

Write and run tests

Confirmation starts writing and fresh verification. Open Tests to choose saved tests and an Environment for a Run.

The Jobs API, CLI, Slack, and repository guides describe the separate earlier Job workflow. They do not start mapping or run these saved tests.

See Quickstart for setup steps.