API リファレンス解説動画とスライド
解説とストーリー
info モードと story モード — それぞれが何を描き、どちらを選ぶか、そして両者を分ける 1 つのフィールド。
info と story は、共通の storybook エンドポイントにある 3 つのモードのうちの 2 つです。エンドポイント、
リクエストパラメータ、ポーリング、ステータス、動画のレンダリング手順については、
解説動画とスライドの概要 を参照してください。本ページでは、
この 2 つのモードに固有の内容だけを扱います。
mode は任意で、省略すると info になります。リクエストのそれ以外の部分は両者で完全に同じです — 同じ
エンドポイント、同じパラメータ、同じレスポンス構造です。それぞれが何を描くかは
概要ページのモード表 にまとめられています。
どちらを選ぶか
ソースに見せる価値のある構造があるときは info を選びます:比較、プロセス、一連の数値など。ビジュアルは
チャートや図解が中心になり、表紙は雑誌の特集記事のように読めます。
ソースが物語になっているときは story を選びます:カスタマージャーニー、創業ストーリー、事例紹介など。
ビジュアルは図解ではなくシーンのイラストになるため、統計データのページは、チャートとしてプロットされるのではなく
シーンとして描かれて返ってきます。
例
curl -X POST "https://api.marswave.ai/openapi/v1/storybook/episodes" \
-H "Authorization: Bearer $LISTENHUB_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"sources": [
{"type": "url", "content": "https://example.com/quarterly-report"}
],
"speakers": [{"speakerId": "<SPEAKER_ID>"}],
"language": "en",
"mode": "info"
}'curl -X POST "https://api.marswave.ai/openapi/v1/storybook/episodes" \
-H "Authorization: Bearer $LISTENHUB_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"sources": [
{"type": "text", "content": "How a two-person team shipped their first product in ninety days..."}
],
"speakers": [{"speakerId": "<SPEAKER_ID>"}],
"language": "en",
"mode": "story"
}'どちらも episodeId を返します。それをポーリングし、必要に応じて動画をレンダリングしてください —
ワークフロー を参照してください。