Skip to main content
GET
Find investor beliefs or inspect a full record

Authorizations

Authorization
string
header
required

Developer API key created through /auth.md. Never paste it into a retail chat.

Headers

X-Request-ID
string

Stable 1–128 character ID for an idempotent retry. Reuse the same value only for the same logical request.

Maximum string length: 128
Pattern: ^[A-Za-z0-9._~:+/=-]+$

Query Parameters

ticker
string
Required string length: 1 - 32
as_of
string<date-time>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
limit
integer

Page size; defaults to 5. Use the returned cursor for more.

Required range: 1 <= x <= 50
cursor
string
Required string length: 1 - 2048
person_id
string
Required string length: 1 - 128
direction
enum<string>
Available options:
bullish,
bearish,
mixed,
neutral,
non_directional,
unknown
status
enum<string>
Available options:
forming,
active,
strengthened,
weakened,
reversed,
resolved,
abandoned,
unknown
time_horizon
string
Required string length: 1 - 128
changed_since
string<date-time>

Find initial research, author revisions, condition checks/plans or released outcomes becoming available after this cutoff. Keeps author dates and stance separate from system activity. Release changes and a complete ordered event-history checkpoint are not yet included.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
entity_id
string<uuid>

Canonical subject ID. Use view=entities to discover IDs.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
view
enum<string>

Discover released canonical subjects, including non-ticker research.

Available options:
entities,
changes
checkpoint
string
Required string length: 1 - 2048
corpus
string
Allowed value: "released"
resync
boolean
q
string
Required string length: 1 - 80
kind
enum<string>
Available options:
company,
instrument,
commodity,
macro_variable,
industry,
sector,
theme,
country,
geography,
person,
policy,
event_series,
event_occurrence,
currency,
index
belief_id
string
Required string length: 1 - 128
visual_id
string

Use a visual_id returned by this belief's visuals.descriptors to inspect one saved visual.

Pattern: ^[a-f0-9]{64}$
visual_offset
integer

Continue visual descriptors using next_visual_offset; requires belief_id and cannot accompany visual_id.

Required range: 0 <= x <= 9007199254740991
region_id
string

Use a region_id returned in the selected visual's regions to retrieve structured data.

Pattern: ^[a-f0-9]{64}$
region_offset
integer

Continue a selected visual's region descriptors using next_region_offset.

Required range: 0 <= x <= 9007199254740991
row_offset
integer

Zero-based starting row or chart-point index in the selected region.

Required range: 0 <= x <= 999
row_limit
integer

Rows or chart points per read; defaults to 50, maximum 100.

Required range: 1 <= x <= 100

Response

Successful read only response

schema_version
string
required
Allowed value: "1"
generated_at
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
as_of
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
resource
string
required
Allowed value: "beliefs"
data_status
object
required
methodology_versions
object
required
citations
object[]
required
warnings
string[]
required
Minimum string length: 1
pagination
object
required
data
object
required