Quickstart
Create your first PoQ project: bring your data, describe the validations you want, and get your datapoints ready for review. Two paths get you there:
| Path | Use it when |
|---|---|
| In the UI | You want visual previews and the fastest way to a first project |
| Via the API | You want PoQ inside an existing workflow, driven by code or an AI agent |
Both paths follow the same PoQ workflow: Define, Validate, Attest. The steps below cover Define. From there, validators score each datapoint against your rubric, and the engine seals the outcome into a signed PoQ Report.
Create a project in the UI
| Step | Action |
|---|---|
| 1 | Log in to PoQ with your email here. |
| 2 | From the Dashboard page, click the New Project button in the upper right corner. |
| 3 | Select the Custom dataset folder option, click Pick folder, and choose the folder that contains your data artifacts and a poq.md file describing the validations you want performed in plain language. |
| 4 | Review the generated validator preview UI and iterate until it gathers the desired data. |
Create a project via the API
You need an API key and a JSON project spec (a mirror of poq.toml):
| Step | Action |
|---|---|
| 1 | Create an API key at API Keys. Copy the token, which is shown only once. |
| 2 | Verify connectivity with GET https://sapien-poq.up.railway.app/developer/v1/ping, passing your key as a bearer token. A valid key returns { "pong": true }. |
| 3 | Create a project with POST https://sapien-poq.up.railway.app/developer/v1/projects, sending name and spec (JSON). |
| 4 | Open an upload session on the new project, declaring each file with relPath and size. |
| 5 | PUT each file's bytes to its presigned uploadUrl (no auth header on these PUTs). |
| 6 | Call process on the session, then poll status until the ingest run finishes. |
The same workflow is available over MCP for AI agents. See the MCP server reference and start with its get_started tool.
See also
| Page | Description |
|---|---|
| The PoQ workflow | How data flows from project definition to attestation |
| API keys | Key lifecycle, authorization, and security |
| Developer API | Full HTTP endpoint reference |
| MCP server | Tool catalog and client setup |