Request Models

Complete reference for all API request schemas.

WorkflowRequest

Used to start a new workflow.

{
  prompt: string;              // User prompt for workflow (required)
  serviceId: string;           // Service ID for credit checking (required)
  threadId?: string;           // Thread ID to continue existing workflow
  total_target?: number;       // Target number of results
  additional_criteria?: CriteriaItem[];  // Pre-defined criteria
  type?: string;               // 'list_builder' | 'base_data_list' | 'predefined_agent'
  list_name?: string;          // Custom list name
  list_description?: string;   // Custom list description
  list_id?: string;            // Existing list ID
}

HumanFeedbackRequest

Used to continue a workflow with additional criteria.

{
  thread_id: string;           // Thread ID (required)
  total_target: number;        // Total target count (required)
  additional_criteria?: CriteriaItem[];  // New criteria to add
  current_criteria?: CriteriaItem[];     // Existing criteria
  serviceId?: string;          // Service ID for credit checking
}

ResearchRequest

Start a deep research workflow.

{
  query: string;               // Research query (required)
  serviceId: string;           // Service ID (required)
  allow_clarification?: boolean;         // Allow clarification questions
  max_concurrent_research_units?: number;  // Max parallel agents
  max_researcher_iterations?: number;      // Max iterations per agent
  tenant_id?: string;          // Tenant identifier
}

EnrichmentRequest

Request for enriching company data.

{
  company_data: object;        // Original company data (required)
  criteria: CriteriaItem[];    // Criteria to enrich (required)
  row_id: string;              // Table row ID (required)
  enrichment_type: string;     // 'company' | 'person' | 'article' (required)
  thread_id?: string;          // Original thread ID for context
}

DeepEnrichmentRequest

Batch enrichment for multiple companies.

{
  companies_to_enrich: object[];  // Array of companies (required)
  list_id: string;                // List ID (required)
  thread_id: string;              // Thread ID (required)
}

EnrichmentCreateRequest

Create enrichment with background processing.

{
  thread_id: string;           // Thread ID (required)
  column_name: string;         // Column name (required)
  instruction: string;         // Enrichment instruction (required)
  enrichment_type: string;     // Type of enrichment (required)
  options?: string[];          // Enrichment options
  list_id?: string;            // List ID
  data_type?: string;          // Expected data type
}

CSVImportReviewRequest

Continue CSV import after user review.

{
  column_descriptions: CSVColumnDescription[];  // Column descriptions (required)
  listName?: string;           // Custom list name
  listDescription?: string;    // List description
  description?: string;        // Alternative description
  category?: string;           // Workflow category
}

CompanyOverviewRequest

Generate company overview from website.

{
  companyUrl: string;          // Company website URL (required)
  companyName: string;         // Company name (required)
}

ServiceRoutingRequest

Route a prompt to appropriate service.

{
  prompt: string;              // User prompt (required)
}