Base URL
The Humancheck API is available at:http://localhost:8000 by configuring your humancheck.yaml file.
Authentication
All API requests require authentication using an API key. Include your API key in theAuthorization header:
Python Example
cURL Example
API Endpoints
Reviews
POST /reviews- Create a new reviewGET /reviews- List reviewsGET /reviews/{review_id}- Get a specific reviewPOST /reviews/{review_id}/decide- Make a decision on a reviewGET /reviews/{review_id}/decision- Get the decision for a reviewPOST /reviews/{review_id}/feedback- Submit feedback on a review
Organizations & Users
POST /organizations- Create an organizationGET /organizations/{org_id}- Get an organizationPOST /users- Create a userPOST /teams- Create a teamPOST /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:- Swagger UI: https://api.humancheck.dev/docs
- ReDoc: https://api.humancheck.dev/redoc
Next Steps
- Explore Review Endpoints
- Check out Organization Endpoints
- Learn about Statistics