API reference

Look up classes, functions, parameters and return values here. To learn the workflow, see the User guide; to run a campaign, see the First campaign.

Find an API by task

Task	Main entry points	Reference
Configure and run a campaign	CampaignConfig, Campaign, CampaignResult	Campaign
Check a config before a run	Campaign.check, CheckReport, factor-agent check	Campaign
Check candidate code	Gate, Graph, Vocabulary, Zoo, stages.split	Gate and vocabulary
Score candidates	Evaluator, Metrics, Scoring, SessionColumns	Evaluation
Judge and export accepted factors	Acceptance, AcceptanceReport, GraphFactor	Acceptance and export
Connect a language model	LLMBackend, make_backend, OpenAICompatibleBackend	LLM backends
Read run directories, serve the frontend	list_runs, RunView, factor-agent-web	Web frontend

Each object page gives its signature and description, followed by parameters, return values, exceptions and examples where documented. The Module index lists every module. The Index finds objects by name.