Company API
The Company API lets you manage company records (also called “projects”) in Kruncher.ai. Below is an overview of everything you can do.
Endpoints
Companies
| Endpoint | Description |
|---|---|
| Create Company | Add a new company with optional automatic analysis |
| Find Companies | List all companies with pagination and filtering |
| Search Projects | Search companies by name or keywords |
Analysis
| Endpoint | Description |
|---|---|
| Trigger Analysis | Step-by-step guide to find a company and run a new analysis |
| Create Analysis | Create a new analysis for an existing company |
| Upload Files | Upload documents (PDF, DOCX, XLSX) to an analysis |
Pipeline & Organization
| Endpoint | Description |
|---|---|
| Change Status | Move a company through pipeline stages |
| Add Comment | Add notes or comments to a company |
| Set Criteria | Define investment criteria and scoring rules |
| Update Criteria | Update existing criteria values |
| Find Lists | Get project lists (groupings) |
| Assign to List | Add or remove a company from a list |
Reports
| Endpoint | Description |
|---|---|
| Company Report | Retrieve the full analysis report for a company |
| Report Metrics | Access specific analysis metrics |
| Data Model | Reference for all report data fields |
Last updated on