Skip to content

Features & Cultural API Reference

Base URL: /api/v1Last Updated: 2026-02-04


Morning Ritual (/api/v1/ritual)

GET /api/v1/ritual/check

Check if it's morning ritual time for user.

  • Auth: Required

GET /api/v1/ritual/content

Get morning ritual playlist content.

  • Auth: Required

GET /api/v1/ritual/ai-brief

Get AI-generated personalized morning brief.

  • Auth: Required

GET /api/v1/ritual/israel-now

Get current context about Israel.

  • Auth: None

POST /api/v1/ritual/preferences

Update morning ritual preferences.

  • Auth: Required
  • Request Body: RitualPreferencesUpdate

GET /api/v1/ritual/preferences

Get current morning ritual preferences.

  • Auth: Required

POST /api/v1/ritual/skip-today

Skip morning ritual for today.

  • Auth: Required

GET /api/v1/ritual/should-show

Quick check if ritual should be shown.

  • Auth: Optional

Judaism (/api/v1/judaism)

Calendar

MethodPathAuthDescription
GET/judaism/calendar/todayNoneGet today's Jewish calendar information
GET/judaism/calendar/shabbatNoneGet Shabbat times for a city. Query: city, state, geoname_id
GET/judaism/calendar/daf-yomiNoneGet today's Daf Yomi
GET/judaism/calendar/holidaysNoneGet upcoming Jewish holidays. Query: days (default 30)
GET/judaism/calendar/citiesNoneGet available cities for Shabbat times

Shabbat

MethodPathAuthDescription
GET/judaism/shabbat/featuredNoneGet featured Shabbat content
GET/judaism/shabbat/statusNoneGet current Shabbat status. Query: city, state

Content

MethodPathAuthDescription
GET/judaism/categoriesNoneGet Judaism content categories
GET/judaism/contentNoneGet Judaism content. Query: category, page, limit
GET/judaism/featuredNoneGet featured Judaism content
GET/judaism/daily-shiurNoneGet daily Torah class recommendation
GET/judaism/liveNoneGet currently live Torah classes

Jewish News

MethodPathAuthDescription
GET/judaism/newsNoneGet aggregated Jewish news. Query: category, source, page, limit
GET/judaism/news/sourcesNoneGet Jewish news sources

Community Directory

MethodPathAuthDescription
GET/judaism/community/regionsNoneGet supported US regions
GET/judaism/community/synagoguesNoneGet synagogues. Query: region, denomination, page, limit
GET/judaism/community/kosherNoneGet kosher restaurants. Query: region, city, state, certification
GET/judaism/community/jccNoneGet JCC locations. Query: region, page, limit
GET/judaism/community/mikvaotNoneGet mikvah locations. Query: region, page, limit
GET/judaism/community/eventsNoneGet community events. Query: region, event_type, days
GET/judaism/community/organization/{org_id}NoneGet organization details
GET/judaism/community/searchNoneSearch community directory

Torah Shiurim

MethodPathAuthDescription
GET/judaism/shiurimNoneGet Torah shiurim from RSS. Query: category, rabbi, source, page, limit
GET/judaism/shiurim/liveNoneGet live Torah classes
GET/judaism/shiurim/dailyNoneGet daily shiur recommendation

Admin

MethodPathAuthDescription
POST/judaism/admin/community/seedAdminSeed sample community data
POST/judaism/admin/news/refreshAdminClear news cache
POST/judaism/admin/shiurim/refreshAdminClear shiurim cache
POST/judaism/admin/content/seedAdminSeed Judaism content
DELETE/judaism/admin/content/clearAdminClear Judaism content

Jerusalem (/api/v1/jerusalem)

MethodPathAuthDescription
GET/jerusalem/contentOptionalGet Jerusalem-focused content. Query: category, page, limit, geo params
GET/jerusalem/featuredOptionalGet featured Jerusalem content
GET/jerusalem/categoriesOptionalGet Jerusalem categories
GET/jerusalem/kotelOptionalGet Western Wall content
GET/jerusalem/kotel/eventsOptionalGet Kotel events
GET/jerusalem/idf-ceremoniesOptionalGet IDF ceremony news
GET/jerusalem/diasporaOptionalGet diaspora connection news
GET/jerusalem/sourcesOptionalGet Jerusalem content sources
POST/jerusalem/admin/refreshAdminClear Jerusalem cache

Tel Aviv (/api/v1/tel-aviv)

MethodPathAuthDescription
GET/tel-aviv/contentOptionalGet Tel Aviv-focused content. Query: category, page, limit, geo params
GET/tel-aviv/featuredOptionalGet featured Tel Aviv content
GET/tel-aviv/categoriesOptionalGet Tel Aviv categories
GET/tel-aviv/beachesOptionalGet beaches content
GET/tel-aviv/nightlifeOptionalGet nightlife content
GET/tel-aviv/cultureOptionalGet culture content
GET/tel-aviv/musicOptionalGet music scene content
GET/tel-aviv/sourcesOptionalGet Tel Aviv sources
POST/tel-aviv/admin/refreshAdminClear Tel Aviv cache

Cultures (/api/v1/cultures)

MethodPathAuthDescription
GET/culturesOptionalList all cultures. Query: active_only (default true)
GET/cultures/defaultOptionalGet default culture
GET/cultures/{culture_id}OptionalGet culture details
GET/cultures/{culture_id}/citiesOptionalGet culture cities. Query: featured_only
GET/cultures/{culture_id}/cities/{city_id}OptionalGet city details
GET/cultures/{culture_id}/cities/{city_id}/contentOptionalGet city content
GET/cultures/{culture_id}/trendingOptionalGet trending culture content
GET/cultures/{culture_id}/featuredOptionalGet featured culture content
GET/cultures/{culture_id}/timeOptionalGet culture timezone info
GET/cultures/{culture_id}/categoriesOptionalGet culture categories
GET/cultures/{culture_id}/sourcesOptionalGet culture news sources

Location (/api/v1)

GET /api/v1/location/reverse-geocode

Convert coordinates to city/state.

  • Auth: None
  • Rate Limit: 30/minute
  • Query Params: latitude, longitude

POST /api/v1/location-consent

Grant/revoke location consent.

  • Auth: Optional
  • Request Body: ConsentRequest

Get consent status.

  • Auth: Optional

NLP (Natural Language Processing) (/api/v1/nlp)

MethodPathAuthDescription
POST/nlp/sessionsNoneCreate conversation session
GET/nlp/sessions/{session_id}NoneGet session details
DELETE/nlp/sessions/{session_id}NoneEnd session
POST/nlp/confirm-actionNoneConfirm pending action
POST/nlp/parse-commandNoneParse natural language command
POST/nlp/execute-agentNoneExecute agent workflow
POST/nlp/search-contentNoneSemantic content search
POST/nlp/voice-commandNoneProcess voice command
GET/nlp/healthNoneNLP service health check

Live Trivia (/api/v1/trivia)

GET /api/v1/trivia/preferences

Get user trivia preferences.

  • Auth: Required

PUT /api/v1/trivia/preferences

Update trivia preferences.

  • Auth: Required
  • Request Body: TriviaPreferencesRequest

GET /api/v1/trivia/admin/topics/{channel_id}

Get channel topics. Admin only.

  • Auth: Required (Admin)
  • Query Params: limit (default 50)

GET /api/v1/trivia/admin/sessions/{user_id}

Get user sessions. Admin only.

  • Auth: Required (Admin)
  • Query Params: limit (default 20)

Quiz (/api/v1/quiz)

GET /api/v1/quiz/health

Health check for quiz service.

  • Auth: None

GET /api/v1/quiz/{content_id}

Get or generate quiz for kids content.

  • Auth: Required
  • Query Params: profile_id, language

POST /api/v1/quiz/{quiz_id}/submit

Submit quiz answers and receive score with rewards.

  • Auth: Required
  • Request Body: QuizSubmitRequest

GET /api/v1/quiz/history/me

Get user's quiz history with statistics.

  • Auth: Required
  • Query Params: profile_id, limit, offset

Rewards (/api/v1/rewards)

GET /api/v1/rewards/me

Get current user's rewards (points, badges, streaks).

  • Auth: Required
  • Query Params: profile_id

GET /api/v1/rewards/stats

Get quick reward stats for UI display.

  • Auth: Required
  • Query Params: profile_id

GET /api/v1/rewards/badges

Get all available badges (public).

  • Auth: None

GET /api/v1/rewards/badges/{badge_id}

Get details for specific badge.

  • Auth: None

Comprehension (/api/v1/comprehension)

GET /api/v1/comprehension/{content_id}/question

Get comprehension question for scene (deducts beta credits).

  • Auth: Required
  • Query Params: scene_start, scene_end, language

POST /api/v1/comprehension/questions/{question_id}/submit

Submit answer to comprehension question.

  • Auth: Required
  • Request Body: ComprehensionSubmitRequest

GET /api/v1/comprehension/{content_id}/scenes

Get scene markers for content.

  • Auth: Required

Support (/api/v1/support)

Voice Support

MethodPathAuthDescription
POST/support/chatRequiredVoice support chat endpoint
POST/support/chat/streamRequiredStreaming voice support chat (SSE)
WebSocket/support/voiceRequiredReal-time voice support. Query: token, language, conversation_id, voice_id
POST/support/chat/rateRequiredRate a voice support conversation

Tickets (User)

MethodPathAuthDescription
POST/support/ticketsRequiredCreate a new support ticket
GET/support/ticketsRequiredList current user's tickets. Query: page, page_size, status
GET/support/tickets/{ticket_id}RequiredGet a specific ticket
POST/support/tickets/{ticket_id}/messagesRequiredAdd a message to a ticket thread

Tickets (Admin)

MethodPathAuthDescription
GET/support/admin/ticketsAdminList all tickets
GET/support/admin/tickets/{ticket_id}AdminGet ticket with admin details
PATCH/support/admin/tickets/{ticket_id}AdminUpdate ticket status/priority/assignment
POST/support/admin/tickets/{ticket_id}/messagesAdminAdd a support response
POST/support/admin/tickets/{ticket_id}/notesAdminAdd an internal note

FAQ

MethodPathAuthDescription
GET/support/faqNoneGet FAQ entries. Query: category, language
POST/support/faq/{faq_id}/viewNoneRecord a view for FAQ entry
POST/support/faq/{faq_id}/feedbackNoneRecord feedback for FAQ entry

Documentation

MethodPathAuthDescription
GET/support/docsNoneList available documentation
GET/support/docs/{path}NoneGet a specific documentation article
GET/support/docs/searchOptionalSearch documentation articles and FAQ
GET/support/docs/search/popularNoneGet popular search queries
GET/support/docs/search/gapsAdminGet searches with zero results

Analytics (Admin)

MethodPathAuthDescription
GET/support/admin/analyticsAdminGet support analytics

News (/api/v1/news)

GET /api/v1/news/mivzakim

Get Ynet breaking news (mivzakim) - cached for 2 minutes.

  • Auth: None
  • Query Params: limit (default 10)

GET /api/v1/news/cache-info

Get cache status for debugging.

  • Auth: None

Widgets (/api/v1/widgets/system)

MethodPathAuthDescription
GET/widgets/system/availableOptionalGet all available system widgets with is_added flag
GET/widgets/system/myRequiredGet user's subscribed system widgets
POST/widgets/system/{widget_id}/addRequiredAdd a system widget to user's collection
DELETE/widgets/system/{widget_id}/removeRequiredRemove a system widget
PATCH/widgets/system/{widget_id}/positionRequiredUpdate widget position
PATCH/widgets/system/{widget_id}/preferencesRequiredUpdate widget preferences (mute, visibility, order)
POST/widgets/system/{widget_id}/closeRequiredClose/hide a system widget
POST/widgets/system/{widget_id}/showRequiredShow/restore a previously closed widget

Document Status: Complete Last Updated: 2026-02-04 Maintained by: Backend Team

Released under the MIT License.