ListGenerationRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/akta-pro/main/json-schema/akta-pro-list-generation-request-schema.json",
  "title": "ListGenerationRequest",
  "x-generated": "2026-10-07",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/akta-pro-openapi.yml#/components/schemas/ListGenerationRequest",
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "description": "Natural language search query (e.g. 'SaaS companies in the US with Series A funding'). Cannot be used with filters."
    },
    "filters": {
      "type": "object",
      "additionalProperties": true,
      "description": "Structured filter conditions. Use the Filter Builder API to generate valid filters. Cannot be used with query. See filter options at /api-reference/listgen-api."
    },
    "sections": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Data enrichment sections to include. Values: firmographic, business_model, company_assessment, trust_signal, company_hierarchy, digital_presence, financial_estimate, location, management_profile, product_offering, strategic_signal, customer_profile, industry, technology, funding_detail (Subscription, Enterprise), mna_and_investment (Subscription, Enterprise)"
    },
    "sort_by": {
      "type": "string",
      "enum": [
        "relevance",
        "revenue_estimate",
        "valuation_estimate",
        "employee_range",
        "total_funding",
        "founded_year"
      ],
      "description": "Field to sort results by. Default: relevance"
    },
    "sort_order": {
      "type": "string",
      "enum": [
        "asc",
        "desc"
      ],
      "description": "Sort direction. Default: desc"
    },
    "limit": {
      "type": "integer",
      "description": "Maximum companies to return. Default: 50, Max: 500"
    },
    "offset": {
      "type": "integer",
      "description": "Number of results to skip for pagination. Default: 0"
    }
  }
}