Documentation

Read reviews, inspect findings, and request new reviews through the Proofline API. Use the TypeScript or Python SDK, or call the API directly with HTTP.

Quickstart#

List the latest reviews in your organization. Set PROOFLINE_TOKEN to a token with the reviews:read scope and PROOFLINE_ORGANIZATION_ID to your organization's ID. Choose an organization and use Generate a token to fill these values into the examples.

import { ProoflineClient } from "@proofline/sdk";

const client = new ProoflineClient({
  baseUrl: "https://proofline.sh",
  token: process.env.PROOFLINE_TOKEN!,
});
const page = await client.listReviews({
  path: { org_id: process.env.PROOFLINE_ORGANIZATION_ID! },
  query: { limit: 5 },
});
for (const review of page.items) {
  console.log(review.id, review.status);
}

import os
from uuid import UUID
from proofline import ProoflineClient

with ProoflineClient(os.environ["PROOFLINE_TOKEN"]) as client:
    page = client.list_reviews(UUID(os.environ["PROOFLINE_ORGANIZATION_ID"]), limit=5)
    for review in page.items:
        print(review.id, review.status)

curl -sS "https://proofline.sh/api/v1/organizations/$PROOFLINE_ORGANIZATION_ID/reviews?limit=5" \
  -H "Authorization: Bearer $PROOFLINE_TOKEN"

What you can do#

• List reviews and read one review, its assessments and its findings.
• Read the review guidance Proofline applies to a repository.
• Request a review of a pull request or of local changes, or rerun a review.

Every request uses a scoped token for one organization. Authentication explains how to create one. The API reference lists every operation and the scope it needs.

Read these docs as Markdown#

Every page is also Markdown. Add .md to its address, such as /docs/sdks.md, or send Accept: text/markdown. /docs/llms.txt lists every page for agents, and /docs/openapi.json is the OpenAPI document the SDKs are generated from.