Skip to main content
The Humancheck API is a RESTful API that provides endpoints for creating reviews, making decisions, managing organizations, users, and teams, and configuring routing rules.

Base URL

The Humancheck API is available at:
https://api.humancheck.dev
For local development, you can run the API on http://localhost:8000 by configuring your humancheck.yaml file.

Authentication

All API requests require authentication using an API key. Include your API key in the Authorization header:
Authorization: Bearer your-api-key-here
You can get your API key from the Humancheck Dashboard or your organization settings.

Python Example

headers = {
    "Authorization": "Bearer your-api-key-here",
    "Content-Type": "application/json"
}

cURL Example

curl -H "Authorization: Bearer your-api-key-here" \
     https://api.humancheck.dev/reviews

API Endpoints

Reviews

  • POST /reviews - Create a new review
  • GET /reviews - List reviews
  • GET /reviews/{review_id} - Get a specific review
  • POST /reviews/{review_id}/decide - Make a decision on a review
  • GET /reviews/{review_id}/decision - Get the decision for a review
  • POST /reviews/{review_id}/feedback - Submit feedback on a review

Organizations & Users

  • POST /organizations - Create an organization
  • GET /organizations/{org_id} - Get an organization
  • POST /users - Create a user
  • POST /teams - Create a team
  • POST /agents - Register an AI agent

Routing

  • POST /routing-rules - Create a routing rule

Statistics

  • GET /stats - Get review statistics

Health

  • GET /health - Health check endpoint

OpenAPI Specification

The API follows the OpenAPI 3.0 specification. You can view the interactive API documentation at:

Next Steps