generated: '2026-07-21'
method: derived
source: >-
  Derived from openapi/shortkit-openapi.yaml component schemas and the ShortKit object references
  (api/content/object, api/live-streams/object, api/surveys/object, api/analytics/event-object,
  api/ad-config/object).
api: ShortKit API
id_conventions:
  content: UUID
  live_stream: UUID
  survey: UUID
  survey_option: UUID
  survey_placement_rule: UUID
  event: UUID
  user_id: prefix 'user_' (defaults to 'anonymous')
  session_id: prefix 'sess_'
  view_session_id: prefix 'vs_'
  request_id: prefix 'req_' (envelope meta)
  api_key: prefixes 'pk_' (publishable) / 'sk_' (secret)
entities:
- name: Content
  description: A video, image carousel, video carousel, or live-stream item in the feed (core resource).
  key: id
- name: LiveStream
  description: A real-time broadcast; surfaces in the feed as a Content item with contentType live_stream.
  key: id
- name: Survey
  description: A short in-feed poll.
  key: id
- name: SurveyOption
  description: A selectable answer option within a survey.
  key: id
- name: SurveyPlacementRule
  description: A rule governing when/where a survey is injected into the feed.
  key: id
- name: Event
  description: A user-interaction event (impression, playStart, like, share, etc.).
  key: id
- name: AdConfig
  description: Org-level singleton controlling ad-slot interleaving into the feed.
  key: (singleton — no id)
relationships:
- from: Content
  to: LiveStream
  type: belongs_to
  via: liveStreamId
  note: Present when contentType is live_stream.
- from: LiveStream
  to: Content
  type: has_many
  via: clips
  note: Clips generated from a stream recording become Content items.
- from: Survey
  to: SurveyOption
  type: has_many
  via: options
- from: Survey
  to: SurveyPlacementRule
  type: has_many
  via: placementRules
- from: Event
  to: Content
  type: belongs_to
  via: content_id
  note: Null for feed-level events (e.g. feedEntry).
- from: SurveyOption
  to: Survey
  type: belongs_to
  via: survey (parent)