API

ターミナルからページを公開する

HTTPリクエスト2つで、HTMLファイルやフォルダの.zipがURLで公開されます。スクリプトでもCIでも、Claude CodeやCodexのようなコーディングエージェントでも動きます。Freeを含むすべてのプランで使えます。

# 手順1:下書きのページを作る(プレビューのリンク付き)
curl -X POST https://api.convika.com/v1/api/pages \
  -H "Authorization: Bearer $CONVIKA_API_KEY" \
  -F "file=@index.html" \
  -F "name=Launch page"

# 手順2:公開する
curl -X POST https://api.convika.com/v1/api/pages/PAGE_ID/publish \
  -H "Authorization: Bearer $CONVIKA_API_KEY"
無料でAPIキーを作る

クレジットカードは不要です。

3ステップで公開する

  1. 登録したら、ダッシュボードの「設定」にある「APIキー」でキーを作ります。キーが表示されるのはこのときだけなので、すぐにコピーしてください。
  2. キーをCONVIKA_API_KEYという名前でシェルかCIのシークレットに入れます。
  3. curlでHTMLファイルかフォルダの.zipを送ります。1つ目のリクエストでページのidとプレビューのリンクが返ります。2つ目のリクエストでページが公開され、URLが返ります。

応答はすべてJSONです。ページのURLはurlに、idはidに入っています。

REST API

curlやGitHub Actionsのステップなど、HTTPを送れるものならどこからでも呼べます。

ベースURL

https://api.convika.com/v1/api

認証

Authorization: Bearer cvk_...

すべてのリクエストのAuthorizationヘッダーにキーを入れて送ります。キーは作ったワークスペースの中で、作ったメンバーの権限で動きます。

エンドポイントできること
POST /pagesHTMLか.zipからページを作ります。id、URL、状態(draft)、自分だけが見られるプレビューのリンクが返ります。
PUT /pages/{id}ページの新しいバージョンを保存します。公開すると同じURLに反映されます。
POST /pages/{id}/publish最新のバージョンを公開して、公開URLの入ったページを返します。
POST /pages/{id}/unpublishページの公開を停止して下書きに戻します。いつでももう一度公開できます。
GET /pagesワークスペースのページを更新が新しい順に返します。limitとoffsetで続きを取れます。
GET /pages/{id}ページ1つのid、名前、URL、状態、バージョン番号を返します。

リクエストボディ

multipart/form-dataでfile(.htmlファイルか、index.htmlとそれが使うファイルを入れた.zip)を送ります。nameは省略できます。JSONで{"html": "…", "name": "…"}を送ることもできます。.zipはCSS・JavaScript・画像・フォントを中に入れた1つのページになります。convika.comのアップロード欄がフォルダを読むときと同じ処理です。

ページを作って公開する

# 手順1:下書きのページを作る(プレビューのリンク付き)
curl -X POST https://api.convika.com/v1/api/pages \
  -H "Authorization: Bearer $CONVIKA_API_KEY" \
  -F "file=@index.html" \
  -F "name=Launch page"

# 手順2:公開する
curl -X POST https://api.convika.com/v1/api/pages/PAGE_ID/publish \
  -H "Authorization: Bearer $CONVIKA_API_KEY"

公開中のページを同じURLのまま更新する

curl -X PUT https://api.convika.com/v1/api/pages/PAGE_ID \
  -H "Authorization: Bearer $CONVIKA_API_KEY" \
  -F "file=@dist.zip"

curl -X POST https://api.convika.com/v1/api/pages/PAGE_ID/publish \
  -H "Authorization: Bearer $CONVIKA_API_KEY"

返ってくる内容

{
  "id": "PAGE_ID",
  "name": "Launch page",
  "url": "https://your-name.convika.page",
  "state": "live",
  "liveVersion": 2,
  "latestVersion": 2,
  "createdAt": "2026-11-22T09:00:00.000Z",
  "updatedAt": "2026-11-22T09:05:00.000Z",
  "version": 2
}

コーディングエージェント向け

Claude Code、Codex、Cursorなどターミナルで動くエージェントは、curlでページを公開できます。下の手順をエージェントへの指示に貼るか、このページを読ませてください。

  1. CONVIKA_API_KEYが設定されているか確認します。なければダッシュボードの「設定」(https://app.convika.com/settings#api-keys)でキーを作ってexportするようユーザーに頼みます。
  2. ビルドが必要なページならビルドして、ビルド先のフォルダを.zipにします。POST /pagesのfileとして送り、応答のpreviewUrlをユーザーに見せます。
  3. ユーザーが公開すると言ったら、最初の応答のidでPOST /pages/{id}/publishを送ります。応答のurlが公開URLです。
  4. それ以降の変更はPUT /pages/{id}を送ってからもう一度公開します。URLは変わりません。

コマンドではなくMCPのツールとして使いたいときは、ConvikaのMCPサーバーをつないでください。エージェントがチャットの中でページの作成、公開、アクセス数の確認まで行えます。

上限

  • APIの上限はダッシュボードと同じで、プランの内容がそのまま適用されます。同時に公開できるページ数、保存できるページ数、1日に作れるページ数、1日の公開回数はプランのとおりです。
  • ページは、.zipから取り込んだCSSや画像を含めて4 MBまでです。リクエストは10 MBまでです。
  • キー1つにつき1分間に60リクエストまで送れます。それを超えると429が返り、Retry-Afterヘッダーで次に送れるまでの秒数がわかります。

エラー

エラーはすべてJSONで返ります。固定のエラーコードと、対処を書いたメッセージが入っています。形は{"error": "…", "message": "…"}です。

コードステータス対処
missing_api_key401Authorization: Bearerにキーを入れて送ってください。
invalid_api_key401「設定」の「APIキー」で新しいキーを作って、そのキーを使ってください。
cookie_not_accepted401Cookieを付けずに、APIキーだけを付けて送ってください。ブラウザではなくスクリプトかターミナルから送ります。
rate_limited429Retry-Afterの秒数だけ待ってから、もう一度送ってください。
not_found404GET /pagesでページのidを確認してください。
not_html400HTML全体(<html>から</html>まで)を送ってください。
html_too_large413大きな画像はURLで読み込むようにして、ページを4 MBに収めてください。
bundle_no_html422.zipにページのindex.htmlを入れてください。
bundle_unbuilt422プロジェクトをビルドして、distかbuildかoutのフォルダを送ってください。
live_page_limit403公開中のページの公開を停止するか、同時に公開できるページ数の多いプランに変えてください。メッセージに公開中のページが載っています。
site_limit_reached403プランで保存できるページ数を使い切っています。PUTで既存のページを更新するか、保存できるページ数の多いプランに変えてください。
publish_daily_limit429UTCの0時(日本時間の午前9時)を過ぎてからもう一度公開するか、1日の公開回数の多いプランに変えてください。

キーの管理

  • キーが表示されるのは作ったときの1回だけです。Convikaが保存するのはキーのハッシュだけです。
  • キーには使う場所の名前(GitHub Actions、自分のPCなど)を付けられます。最後に使った日は「設定」で確認できます。
  • 「設定」でキーを無効にすると、そのキーはすぐに使えなくなります。公開したページは公開されたままです。
  • キーで使えるのはページを公開するAPIだけです。請求、メンバー、キーの管理はAPIキーでは操作できません。ダッシュボードにログインして行います。

よくある質問

ConvikaのAPIは無料で使えますか?

使えます。APIキーとREST APIはFreeを含むすべてのプランで使えます。プランのページ数の上限は、APIでもダッシュボードでも同じです。

URLを変えずにページを更新できますか?

できます。PUT /pages/{id}のあとにPOST /pages/{id}/publishを送ってください。新しいバージョンが同じURLで公開され、前のバージョンはページの履歴に残ります。

GitHub ActionsなどのCIから公開できますか?

できます。キーをCONVIKA_API_KEYという名前のシークレットに保存して、ビルドのあとにcurlでページを送るステップを足してください。PUT /pages/{id}でファイルを送り、POST /pages/{id}/publishで公開します。curlが動くCIならどれでも使えます。

CSSやJavaScriptや画像の入ったフォルダも公開できますか?

できます。フォルダを.zipにして送ってください。Convikaがindex.htmlを見つけて、使われているCSS・JavaScript・画像・フォントをページの中に入れます。全部で4 MBまでです。

公開したページでは何が使えますか?

Cloudflareのネットワークで配信される公開URL、フォームの回答の受信、アクセス解析(流入元とボタンのクリック)、前のバージョンに戻せる履歴が使えます。独自ドメインもつなげます。

最初のページをターミナルから公開する

キーを作ってページを送れば、共有できるURLが手に入ります。

無料でAPIキーを作る