Skip to main content
People Intelligence and Company Intelligence accept a struct field that defines exactly what data you want returned in structured_data. This guide explains how struct works and how the API resolves and casts types.

How struct works

Each key in struct becomes a field in the response’s structured_data, and its value tells the agent what to find. You can pass either a plain-English description or an object with description and type:
The agent uses these descriptions to guide its research. Be specific — "company's primary Instagram handle" returns better results than "social". QA Agent accepts string descriptions only and returns those extra fields as strings; the typed objects and casting rules below do not apply to it.

Type casting

The API automatically handles type casting with intelligent type preservation.

Resolution priority

Type resolution follows this priority:
  1. Explicit type definitions in struct (highest)
  2. Original input types from the request body (e.g., target_company, lead_info, data)
  3. Inferred types from example values in struct
  4. String (default)

Supported types

The "dict" type returns a stringified JSON value, not a nested typed object. Parse it client-side with json.loads() (Python) or JSON.parse() (JavaScript).

Examples

Type override — explicit type in struct overrides the original input type:
Explicit type definition — useful when you want predictable shapes:
Type inference from values — types are inferred from the example values you pass: