# HeyBee

> Compare AI outputs with real human judgments.

## Docs

- [CLI](https://docs.heybee.app/developers/cli.md): Every HeyBee workflow from your terminal, with stable JSON for scripts.
- [Python SDK](https://docs.heybee.app/developers/python-sdk.md): Run the full evaluation lifecycle from Python, sync or async.
- [Agent Skills](https://docs.heybee.app/developers/skills.md): Let coding agents run HeyBee evaluations end to end.
- [Introduction](https://docs.heybee.app/index.md): HeyBee helps you decide which AI output is better, backed by real human judgments.
- [Plans and billing](https://docs.heybee.app/product/billing-account.md): What each plan includes, how credits work, and how to manage your subscription.
- [Add outputs](https://docs.heybee.app/product/datalab-imports.md): Upload tables, media files, and datasets, and fix issues before voters see anything.
- [Create an evaluation](https://docs.heybee.app/product/evaluations.md): Define what you are comparing, how voters judge it, and when it is ready to collect.
- [Quickstart](https://docs.heybee.app/product/getting-started.md): Create an evaluation, collect your first votes, and read the result.
- [Privacy and data](https://docs.heybee.app/product/privacy-account.md): Control optional data processing, export everything, or delete your account.
- [Read your results](https://docs.heybee.app/product/results.md): The verdict, what the confidence score means, and when to stop collecting.
- [Teams and roles](https://docs.heybee.app/product/teams.md): Share a workspace, control who can do what, and manage seats.
- [Troubleshooting](https://docs.heybee.app/product/troubleshooting.md): Fixes for the most common upload, collection, and access problems.
- [Collect votes](https://docs.heybee.app/product/voting.md): Share voting links, set limits, and see exactly what voters experience.
- [Create Evaluation Export](https://docs.heybee.app/reference/analytics/create-evaluation-export.md)
- [Download Evaluation Export](https://docs.heybee.app/reference/analytics/download-evaluation-export.md)
- [Get Activity Timeline](https://docs.heybee.app/reference/analytics/get-activity-timeline.md): Adaptive vote-over-time series (window and resolution sized from the real vote span).
- [Get Candidate Benchmark](https://docs.heybee.app/reference/analytics/get-candidate-benchmark.md): Get anchor-balanced candidate-level benchmark analytics.
- [Get Confidence](https://docs.heybee.app/reference/analytics/get-confidence.md): Get confidence metrics for an experiment.
- [Get Dashboard Summary](https://docs.heybee.app/reference/analytics/get-dashboard-summary.md): Get the evaluation dashboard summary for cards and overview.
- [Get Decision Overview](https://docs.heybee.app/reference/analytics/get-decision-overview.md): Get canonical decision-first standard results for an experiment.
- [Get Evaluation Export](https://docs.heybee.app/reference/analytics/get-evaluation-export.md)
- [Get Experiment Analytics Batch](https://docs.heybee.app/reference/analytics/get-experiment-analytics-batch.md): Return selected analytics slices in one request while preserving per-slice caches.
- [Get Full Parameter Analysis](https://docs.heybee.app/reference/analytics/get-full-parameter-analysis.md): Get complete parameter analysis results.
- [Get Insights](https://docs.heybee.app/reference/analytics/get-insights.md): Get generated insights for an experiment.
- [Get Optimal Parameters](https://docs.heybee.app/reference/analytics/get-optimal-parameters.md): Get optimal parameter values.
- [Get Parameter Importance](https://docs.heybee.app/reference/analytics/get-parameter-importance.md): Get parameter importance rankings.
- [Get Parameter Interactions](https://docs.heybee.app/reference/analytics/get-parameter-interactions.md): Get detected parameter interactions.
- [Get Rankings](https://docs.heybee.app/reference/analytics/get-rankings.md): Get sample rankings for an experiment.
- [Get Sample Stats](https://docs.heybee.app/reference/analytics/get-sample-stats.md): Per-output Elo and win/loss for the experiment's ranked outputs (for distribution charts).
- [Get Statistics](https://docs.heybee.app/reference/analytics/get-statistics.md): Get statistical summary for an experiment.
- [Get Vote Outcomes](https://docs.heybee.app/reference/analytics/get-vote-outcomes.md): Distribution of valid votes by outcome (A wins / B wins / tie / both bad / can't tell).
- [Get Workspace Activity](https://docs.heybee.app/reference/analytics/get-workspace-activity.md): Get aggregated daily vote activity across the authenticated user's workspace.
- [Create Api Key](https://docs.heybee.app/reference/authentication/create-api-key.md): Create a new API key.
- [List Api Keys](https://docs.heybee.app/reference/authentication/list-api-keys.md): List all active API keys for the current user.
- [Revoke Api Key](https://docs.heybee.app/reference/authentication/revoke-api-key.md): Revoke an API key.
- [Revoke Current Api Key](https://docs.heybee.app/reference/authentication/revoke-current-api-key.md): Revoke the API key authenticating this request without exposing other keys.
- [Fund Experiment Pool](https://docs.heybee.app/reference/economy/fund-experiment-pool.md)
- [Get Experiment Credit Status](https://docs.heybee.app/reference/economy/get-experiment-credit-status.md)
- [Get My Balance](https://docs.heybee.app/reference/economy/get-my-balance.md)
- [List Credit Transactions](https://docs.heybee.app/reference/economy/list-credit-transactions.md)
- [Refund Experiment Pool](https://docs.heybee.app/reference/economy/refund-experiment-pool.md)
- [Set Experiment Budget](https://docs.heybee.app/reference/economy/set-experiment-budget.md)
- [Create Experiment](https://docs.heybee.app/reference/experiments/create-experiment.md): Create a new experiment.
- [Create Generation Suggestions](https://docs.heybee.app/reference/experiments/create-generation-suggestions.md): Suggest high-value next parameter configurations for sample generation scripts.
- [Delete Experiment](https://docs.heybee.app/reference/experiments/delete-experiment.md): Soft-delete an experiment (sets deleted_at).
- [Get Experiment](https://docs.heybee.app/reference/experiments/get-experiment.md): Get a single experiment by ID.
- [Get Experiment Voting Context](https://docs.heybee.app/reference/experiments/get-experiment-voting-context.md): Return metadata that public voters need before voting.
- [List Experiments](https://docs.heybee.app/reference/experiments/list-experiments.md): List experiments accessible to the current user.
- [List Public Experiments](https://docs.heybee.app/reference/experiments/list-public-experiments.md): List public experiments for discovery.
- [List Workspace Experiments](https://docs.heybee.app/reference/experiments/list-workspace-experiments.md): List only experiments in the user's private workspace.
- [Share Experiment To Team](https://docs.heybee.app/reference/experiments/share-experiment-to-team.md): Share a personal experiment into a team workspace.
- [Update Experiment](https://docs.heybee.app/reference/experiments/update-experiment.md): Update an experiment.
- [Create Huggingface Import](https://docs.heybee.app/reference/hugging-face-imports/create-huggingface-import.md)
- [Delete Huggingface Import](https://docs.heybee.app/reference/hugging-face-imports/delete-huggingface-import.md)
- [Get Huggingface Import](https://docs.heybee.app/reference/hugging-face-imports/get-huggingface-import.md)
- [Huggingface Media Proxy](https://docs.heybee.app/reference/hugging-face-imports/huggingface-media-proxy.md)
- [Huggingface Media Proxy](https://docs.heybee.app/reference/hugging-face-imports/huggingface-media-proxy-1.md)
- [List Huggingface Imports](https://docs.heybee.app/reference/hugging-face-imports/list-huggingface-imports.md)
- [Retry Huggingface Import](https://docs.heybee.app/reference/hugging-face-imports/retry-huggingface-import.md)
- [Create Huggingface Experiment Import](https://docs.heybee.app/reference/hugging-face/create-huggingface-experiment-import.md): Create a new experiment from a dataset and import into it (import-first UX).
- [Huggingface Compatibility](https://docs.heybee.app/reference/hugging-face/huggingface-compatibility.md)
- [Huggingface Dataset Schema](https://docs.heybee.app/reference/hugging-face/huggingface-dataset-schema.md)
- [Huggingface Dataset Splits](https://docs.heybee.app/reference/hugging-face/huggingface-dataset-splits.md)
- [Huggingface Discovery Batch](https://docs.heybee.app/reference/hugging-face/huggingface-discovery-batch.md)
- [Huggingface Preview](https://docs.heybee.app/reference/hugging-face/huggingface-preview.md)
- [Huggingface Usage](https://docs.heybee.app/reference/hugging-face/huggingface-usage.md)
- [List Huggingface Datasets](https://docs.heybee.app/reference/hugging-face/list-huggingface-datasets.md)
- [Cancel Account Deletion](https://docs.heybee.app/reference/me/cancel-account-deletion.md)
- [Complete My Onboarding Response](https://docs.heybee.app/reference/me/complete-my-onboarding-response.md)
- [Download My Account Export](https://docs.heybee.app/reference/me/download-my-account-export.md)
- [Get My Account Export](https://docs.heybee.app/reference/me/get-my-account-export.md)
- [Get My Consents](https://docs.heybee.app/reference/me/get-my-consents.md)
- [Get My Deletion Request](https://docs.heybee.app/reference/me/get-my-deletion-request.md)
- [Get My Onboarding Response](https://docs.heybee.app/reference/me/get-my-onboarding-response.md)
- [Get My Referral Stats](https://docs.heybee.app/reference/me/get-my-referral-stats.md)
- [Get My User Settings](https://docs.heybee.app/reference/me/get-my-user-settings.md)
- [Get My Vote Activity](https://docs.heybee.app/reference/me/get-my-vote-activity.md)
- [Patch My User Settings](https://docs.heybee.app/reference/me/patch-my-user-settings.md)
- [Patch My Username](https://docs.heybee.app/reference/me/patch-my-username.md)
- [Put My Onboarding Response](https://docs.heybee.app/reference/me/put-my-onboarding-response.md)
- [Record My Consent](https://docs.heybee.app/reference/me/record-my-consent.md)
- [Request Account Deletion](https://docs.heybee.app/reference/me/request-account-deletion.md)
- [Request Account Export](https://docs.heybee.app/reference/me/request-account-export.md)
- [Get Notification Unread Count](https://docs.heybee.app/reference/notifications/get-notification-unread-count.md)
- [List Notification Preferences](https://docs.heybee.app/reference/notifications/list-notification-preferences.md)
- [List Notifications](https://docs.heybee.app/reference/notifications/list-notifications.md)
- [Mark All Notifications As Read](https://docs.heybee.app/reference/notifications/mark-all-notifications-as-read.md)
- [Mark Notification As Read](https://docs.heybee.app/reference/notifications/mark-notification-as-read.md)
- [Mark Notification As Unread](https://docs.heybee.app/reference/notifications/mark-notification-as-unread.md)
- [Upsert Notification Preference](https://docs.heybee.app/reference/notifications/upsert-notification-preference.md)
- [Check Username Availability](https://docs.heybee.app/reference/public/check-username-availability.md)
- [Validate Referral Code](https://docs.heybee.app/reference/public/validate-referral-code.md)
- [Commit Ingestion Manifest](https://docs.heybee.app/reference/samples/commit-ingestion-manifest.md): Validate and commit ingestion payload atomically.
- [Commit Multi Ingestion Manifest](https://docs.heybee.app/reference/samples/commit-multi-ingestion-manifest.md): Commit a multi-experiment ingestion manifest with partition isolation.
- [Create Sample](https://docs.heybee.app/reference/samples/create-sample.md): Create a sample after uploading the file.
- [Create Samples Batch](https://docs.heybee.app/reference/samples/create-samples-batch.md): Create multiple samples in a single request (max 100).
- [Delete Sample](https://docs.heybee.app/reference/samples/delete-sample.md): Soft-delete a sample (sets deleted_at).
- [Get Ingestion Status](https://docs.heybee.app/reference/samples/get-ingestion-status.md): Get persisted status/report for an ingestion batch.
- [Get Sample](https://docs.heybee.app/reference/samples/get-sample.md): Get a single sample by ID.
- [Get Upload Url](https://docs.heybee.app/reference/samples/get-upload-url.md): Get a presigned URL for uploading a file.
- [Get Upload Urls Batch](https://docs.heybee.app/reference/samples/get-upload-urls-batch.md): Generate presigned upload URLs for a batch of assets.
- [List Ingestions](https://docs.heybee.app/reference/samples/list-ingestions.md): List recent ingestions with candidate-level telemetry for DataLab timelines.
- [List Sample Anchors](https://docs.heybee.app/reference/samples/list-sample-anchors.md)
- [List Samples](https://docs.heybee.app/reference/samples/list-samples.md): List samples for an experiment.
- [Plan Multi Ingestion Manifest](https://docs.heybee.app/reference/samples/plan-multi-ingestion-manifest.md): Validate and partition a multi-experiment manifest without committing samples.
- [Validate Ingestion Manifest](https://docs.heybee.app/reference/samples/validate-ingestion-manifest.md): Validate manifest payload without committing samples.
- [Create Support Ticket](https://docs.heybee.app/reference/support/create-support-ticket.md)
- [Accept Team Invite](https://docs.heybee.app/reference/teams/accept-team-invite.md)
- [Accept Team Invite By Token](https://docs.heybee.app/reference/teams/accept-team-invite-by-token.md)
- [Add Team Member](https://docs.heybee.app/reference/teams/add-team-member.md)
- [Create Team](https://docs.heybee.app/reference/teams/create-team.md)
- [Create Team Invite](https://docs.heybee.app/reference/teams/create-team-invite.md)
- [Decline Team Invite](https://docs.heybee.app/reference/teams/decline-team-invite.md)
- [Delete Team](https://docs.heybee.app/reference/teams/delete-team.md)
- [Get Team](https://docs.heybee.app/reference/teams/get-team.md)
- [Get Team Invite By Token](https://docs.heybee.app/reference/teams/get-team-invite-by-token.md)
- [List My Team Invites](https://docs.heybee.app/reference/teams/list-my-team-invites.md)
- [List Team Experiments](https://docs.heybee.app/reference/teams/list-team-experiments.md)
- [List Team Invites](https://docs.heybee.app/reference/teams/list-team-invites.md)
- [List Team Members](https://docs.heybee.app/reference/teams/list-team-members.md)
- [List Teams](https://docs.heybee.app/reference/teams/list-teams.md)
- [Remove Team Member](https://docs.heybee.app/reference/teams/remove-team-member.md)
- [Resend Team Invite](https://docs.heybee.app/reference/teams/resend-team-invite.md)
- [Revoke Team Invite](https://docs.heybee.app/reference/teams/revoke-team-invite.md)
- [Update Team](https://docs.heybee.app/reference/teams/update-team.md)
- [Update Team Member](https://docs.heybee.app/reference/teams/update-team-member.md)
- [Claim Voter Transfer Code](https://docs.heybee.app/reference/voting-sessions/claim-voter-transfer-code.md)
- [Create Session Seat](https://docs.heybee.app/reference/voting-sessions/create-session-seat.md): Create a new anonymous participant and return a device token (shown once).
- [Create Voter Transfer Code](https://docs.heybee.app/reference/voting-sessions/create-voter-transfer-code.md)
- [Create Voting Session](https://docs.heybee.app/reference/voting-sessions/create-voting-session.md): Create a shareable voting session for an experiment.
- [Get Anonymous Next Pair](https://docs.heybee.app/reference/voting-sessions/get-anonymous-next-pair.md): Get the next sticky pair for an anonymous seat.
- [Get Session Progress](https://docs.heybee.app/reference/voting-sessions/get-session-progress.md): Get voting progress for an anonymous seat.
- [Get Voting Session Health](https://docs.heybee.app/reference/voting-sessions/get-voting-session-health.md): Return backend-only anonymous voting telemetry for one voting session.
- [List Session Seats](https://docs.heybee.app/reference/voting-sessions/list-session-seats.md): List anonymous seats for a session (owner only).
- [List Voting Sessions](https://docs.heybee.app/reference/voting-sessions/list-voting-sessions.md): List all voting sessions for an experiment (owner or team manager only).
- [Merge Anonymous Seat Into Account](https://docs.heybee.app/reference/voting-sessions/merge-anonymous-seat-into-account.md)
- [Revoke Session Seat](https://docs.heybee.app/reference/voting-sessions/revoke-session-seat.md): Revoke a specific anonymous seat token (owner only).
- [Revoke Voting Session](https://docs.heybee.app/reference/voting-sessions/revoke-voting-session.md): Revoke a voting session (stops accepting new votes).
- [Submit Anonymous Scores](https://docs.heybee.app/reference/voting-sessions/submit-anonymous-scores.md): Submit per-clip absolute numeric scores for the current served pair.
- [Submit Anonymous Vote](https://docs.heybee.app/reference/voting-sessions/submit-anonymous-vote.md): Submit a vote for the current sticky pair (anonymous seat).
- [Update Voting Session](https://docs.heybee.app/reference/voting-sessions/update-voting-session.md): Update voting session limits (e.g., max seats).
- [Exclude Experiment Vote](https://docs.heybee.app/reference/voting/exclude-experiment-vote.md)
- [Get Next Pair](https://docs.heybee.app/reference/voting/get-next-pair.md): Get the next pair of samples to compare.
- [List Experiment Votes](https://docs.heybee.app/reference/voting/list-experiment-votes.md)
- [List My Votes](https://docs.heybee.app/reference/voting/list-my-votes.md)
- [Submit Vote](https://docs.heybee.app/reference/voting/submit-vote.md): Submit a vote for a pair comparison.
- [Apply Subscription Change](https://docs.heybee.app/reference/workspaces/apply-subscription-change.md)
- [Create Billing Portal Session](https://docs.heybee.app/reference/workspaces/create-billing-portal-session.md)
- [Get Billing Catalog](https://docs.heybee.app/reference/workspaces/get-billing-catalog.md)
- [Get My Credit Balance](https://docs.heybee.app/reference/workspaces/get-my-credit-balance.md)
- [Get My Entitlements](https://docs.heybee.app/reference/workspaces/get-my-entitlements.md)
- [Get My Quotas](https://docs.heybee.app/reference/workspaces/get-my-quotas.md)
- [Get Workspace Credit Balance](https://docs.heybee.app/reference/workspaces/get-workspace-credit-balance.md)
- [Get Workspace Entitlements](https://docs.heybee.app/reference/workspaces/get-workspace-entitlements.md)
- [Get Workspace Quotas](https://docs.heybee.app/reference/workspaces/get-workspace-quotas.md)
- [List Workspaces](https://docs.heybee.app/reference/workspaces/list-workspaces.md)
- [Preview Subscription Change](https://docs.heybee.app/reference/workspaces/preview-subscription-change.md)
- [Start Subscription Checkout](https://docs.heybee.app/reference/workspaces/start-subscription-checkout.md)
- [Start Top Up Checkout](https://docs.heybee.app/reference/workspaces/start-top-up-checkout.md)
- [Support](https://docs.heybee.app/support.md): Get help from the team or the community.

## OpenAPI Specs

- [openapi](https://docs.heybee.app/openapi.json)