Response Models

Complete reference for all API response schemas.

WorkflowStatusResponse

Response from workflow status endpoint.

{
  thread_id: string;           // Thread ID
  current_step: string;        // Current workflow step
  category?: string;           // Workflow category
  criteria: CriteriaItem[];    // Extracted criteria
  error_message?: string;      // Error message if failed
  total_target?: number;       // Target result count
  table_structure?: TableStructure;  // Results table
  all_companies?: object[];    // All companies found
  step_companies?: object;     // Companies by step
  title?: string;              // Workflow title
  description?: string;        // Workflow description
  goal?: object;               // Workflow goal
  processed_companies?: string[];  // Processed company IDs
}

ResearchResponse

Response from research operations.

{
  thread_id: string;           // Thread ID for tracking
  status: string;              // Status of request
  message: string;             // Response message
  research_brief?: string;     // Generated research brief
  final_report?: string;       // Final research report
}

WorkflowRestoreResponse

Response from workflow restore operation.

{
  list_id: string;             // List ID
  status: string;              // Status (default: 'restored')
  criteria: CriteriaItem[];    // Workflow criteria
  total_target: number;        // Target count
  table_structure?: TableStructure;  // Table structure
  title?: string;              // Workflow title
  description?: string;        // Workflow description
  thread_id?: string;          // Thread ID
  listType?: string;           // List type
  supervisor_started: boolean; // Supervisor status
}

HealthResponse

Health check response.

{
  status: string;              // 'healthy' | 'unhealthy'
  timestamp: string;           // ISO 8601 timestamp
  version: string;             // API version
  environment: string;         // Environment name
}

ServiceRoutingResponse

Service routing response.

{
  name: string;                // Service name
  reasoning: string;           // Routing decision explanation
  category: string;            // Service category
  url: string;                 // URL to navigate to
  success: boolean;            // Whether routing succeeded
}

ThreadListResponse

Thread list item.

{
  thread_id: string;           // Thread ID
  tenant_id: string;           // Tenant ID
  order_id: string;            // Order ID
  status: string;              // Thread status
  created_at: string;          // Creation timestamp
  last_updated: string;        // Last update timestamp
}

CamelCaseResponse

Camel case conversion response.

{
  original_value: string;      // Original input
  camel_case: string;          // Converted camelCase value
}

Error Response

Standard error response format.

{
  detail: ValidationError[];   // Array of validation errors
}

ValidationError

{
  loc: (string | number)[];    // Error location path
  msg: string;                 // Error message
  type: string;                // Error type
}