FalconVQA Docs
API Reference

Response objects

Every shape the API returns, with field types — a single reference for building typed clients.

TypeScript definitions for all of these live in frontend/lib/core/types.ts and can be copied directly.

Job

Prop

Type

IngestResult

Prop

Type

Video

Prop

Type

SearchResult

Which fields are populated depends on detail.

Prop

Type

SpeakerTurn

Prop

Type

Chunk

One chunk with whatever each analyzer produced for it, merged onto the same object.

Prop

Type

Only the analyzers that ran appear as keys. Checking "people" in chunk is the right way to ask whether that pass produced anything for this moment.

ChunksResponse

Prop

Type

QueryResponse

Prop

Type

AskResponse

Prop

Type

Entity

Prop

Type

CapabilitiesResponse

The shape GET /analyzers and GET /schema combine into, as the reference client exposes it.

Prop

Type

On this page