Create Company

Create a new company (project) in Kruncher can be done in three different ways.

Three ways to create a company:

projectAnalysisWithFile
Creates a project intended for file-based analysis.
projectAnalysisNoFile
Runs analysis using the website only.
projectNoAnalysis
Creates a project without analysis.

Endpoint

POST https://api.kruncher.ai/api/integration/project

Request body

CODE

{
  "name": "Your Company Nickname",
  "companyName": "Your Company Name",
  "companyWebsite": "https://yourcompany.com",
  "projectType": "projectAnalysisWithFile",
  "docLink": "https://example.com/document.pdf",
  "email": "user@example.com",
  "password": "password123",
  "notesText": "Additional notes about the company..."
}

Fields

Field	Type	Required	Description
`name`	string	Optional	Project nickname (optional).
`companyName`	string	Required	Full legal/company name.
`companyWebsite`	string (URL)	Required when `projectType` is `projectAnalysisNoFile`, otherwise optional	Company website URL.
`projectType`	string	Required	Controls whether analysis is triggered. See Three ways to create a company below.
`docLink`	string (URL)	Optional	Public document URL. When provided with `projectAnalysisWithFile`, the file is downloaded and analyzed automatically.
`email`	string	Optional	Credential for accessing protected `docLink` URLs.
`password`	string	Optional	Credential for accessing protected `docLink` URLs.
`notesText`	string	Optional	Free-text notes that are converted into a file and used for analysis.

Behavior notes

For projectAnalysisWithFile:
- docLink downloads and triggers analysis
- notesText creates a file and triggers analysis
- If neither is provided, upload is manual
For projectAnalysisNoFile:
- companyWebsite is required
- Other file fields are ignored

Code Examples

JavaScript/TypeScript

Basic

CODE

const apiKey = "YOUR_API_KEY_HERE";
 
const response = await fetch("https://api.kruncher.ai/api/integration/project", {
  method: "POST",
  headers: {
    "Authorization": `${apiKey}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    name: "Acme",
    companyName: "Acme Corporation",
    companyWebsite: "https://acme.com",
    projectType: "projectAnalysisNoFile"
  })
});
 
const { project, analysisId } = await response.json();
console.log("Project created:", project.id);
console.log("Analysis ID:", analysisId);

Result: Website-based analysis is triggered automatically.

With File

CODE

const apiKey = "YOUR_API_KEY_HERE";
 
const response = await fetch("https://api.kruncher.ai/api/integration/project", {
  method: "POST",
  headers: {
    "Authorization": `${apiKey}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    name: "Acme",
    companyName: "Acme Corporation",
    companyWebsite: "https://acme.com",
    projectType: "projectAnalysisWithFile",
    docLink: "https://example.com/pitch-deck.pdf"
  })
});
 
const { project, analysisId } = await response.json();
console.log("Project created with file analysis:", project.id);

Result: File is downloaded and analyzed automatically.

Advanced

CODE

const apiKey = "YOUR_API_KEY_HERE";
 
// Function to create a company with error handling
async function createCompany(companyData) {
  try {
    const response = await fetch("https://api.kruncher.ai/api/integration/project", {
      method: "POST",
      headers: {
        "Authorization": `${apiKey}`,
        "Content-Type": "application/json"
      },
      body: JSON.stringify(companyData)
    });
 
    if (!response.ok) {
      throw new Error(`HTTP ${response.status}: ${response.statusText}`);
    }
 
    const result = await response.json();
    return result;
  } catch (error) {
    console.error("Failed to create company:", error.message);
    throw error;
  }
}
 
// Example: Create with protected file
const result = await createCompany({
  name: "Acme",
  companyName: "Acme Corporation",
  companyWebsite: "https://acme.com",
  projectType: "projectAnalysisWithFile",
  docLink: "https://example.com/private.pdf",
  email: "user@example.com",
  password: "securePassword123"
});
 
console.log("Created:", result.project.id);

Result: Protected file is accessed and analyzed.

Python

Basic

CODE

import requests
 
API_KEY = "YOUR_API_KEY_HERE"
url = "https://api.kruncher.ai/api/integration/project"
 
headers = {
    "Authorization": f"{API_KEY}",
    "Content-Type": "application/json"
}
 
data = {
    "name": "Acme",
    "companyName": "Acme Corporation",
    "companyWebsite": "https://acme.com",
    "projectType": "projectAnalysisNoFile"
}
 
response = requests.post(url, headers=headers, json=data)
result = response.json()
 
print(f"Project created: {result['project']['id']}")
print(f"Analysis ID: {result['analysisId']}")

Result: Website-based analysis is triggered.

With Notes

CODE

import requests
 
API_KEY = "YOUR_API_KEY_HERE"
url = "https://api.kruncher.ai/api/integration/project"
 
headers = {
    "Authorization": f"{API_KEY}",
    "Content-Type": "application/json"
}
 
data = {
    "name": "Acme",
    "companyName": "Acme Corporation",
    "companyWebsite": "https://acme.com",
    "projectType": "projectAnalysisWithFile",
    "notesText": "Strong growth in B2B segment. Series A funding raised."
}
 
response = requests.post(url, headers=headers, json=data)
result = response.json()
 
print(f"Project created: {result['project']['id']}")

Result: Notes are converted to a file and analyzed.

Reusable Function

CODE

import requests
from typing import Dict, Optional
 
API_KEY = "YOUR_API_KEY_HERE"
BASE_URL = "https://api.kruncher.ai/api"
 
def create_company(
    name: str,
    company_name: str,
    website: str,
    project_type: str,
    doc_link: Optional[str] = None,
    notes: Optional[str] = None,
    email: Optional[str] = None,
    password: Optional[str] = None
) -> Dict:
    """
    Create a new company in Kruncher.
    
    Args:
        name: Short nickname for the company
        company_name: Full legal name
        website: Company website URL
        project_type: One of projectAnalysisWithFile, projectAnalysisNoFile, projectNoAnalysis
        doc_link: Optional URL to document for analysis
        notes: Optional text notes for analysis
        email: Optional credential for protected links
        password: Optional credential for protected links
    
    Returns:
        Dict containing project and analysisId
    """
    url = f"{BASE_URL}/integration/project"
    headers = {
        "Authorization": f"{API_KEY}",
        "Content-Type": "application/json"
    }
    
    payload = {
        "name": name,
        "companyName": company_name,
        "companyWebsite": website,
        "projectType": project_type
    }
    
    if doc_link:
        payload["docLink"] = doc_link
    if notes:
        payload["notesText"] = notes
    if email:
        payload["email"] = email
    if password:
        payload["password"] = password
    
    try:
        response = requests.post(url, headers=headers, json=payload)
        response.raise_for_status()
        return response.json()
    except requests.exceptions.HTTPError as e:
        print(f"HTTP Error: {response.status_code} - {response.text}")
        raise
    except Exception as e:
        print(f"Error creating company: {str(e)}")
        raise
 
# Usage example
result = create_company(
    name="Acme",
    company_name="Acme Corporation",
    website="https://acme.com",
    project_type="projectAnalysisWithFile",
    doc_link="https://example.com/deck.pdf"
)
 
print(f"Success! Project ID: {result['project']['id']}")

Result: Reusable function with full error handling.

cURL

Website Only

CODE

curl -X POST "https://api.kruncher.ai/api/integration/project" \
  -H "Authorization: YOUR_API_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme",
    "companyName": "Acme Corporation",
    "companyWebsite": "https://acme.com",
    "projectType": "projectAnalysisNoFile"
  }'

With File

CODE

curl -X POST "https://api.kruncher.ai/api/integration/project" \
  -H "Authorization: YOUR_API_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme",
    "companyName": "Acme Corporation",
    "companyWebsite": "https://acme.com",
    "projectType": "projectAnalysisWithFile",
    "docLink": "https://example.com/pitch-deck.pdf"
  }'

With Notes

CODE

curl -X POST "https://api.kruncher.ai/api/integration/project" \
  -H "Authorization: YOUR_API_KEY_HERE" \
  -H "Content-Type: "application/json" \
  -d '{
    "name": "Acme",
    "companyName": "Acme Corporation",
    "companyWebsite": "https://acme.com",
    "projectType": "projectAnalysisWithFile",
    "notesText": "Strong B2B growth. Series A raised."
  }'

Response

Returns the project and analysis ID.

CODE

{
  "project": {
    "id": "proj_123",
    "name": "Acme",
    "companyName": "Acme Corporation",
    "companyWebsite": "https://acme.com",
    "projectType": "projectAnalysisWithFile"
  },
  "analysisId": "analysis_456"
}