Clearnets Creative Studio の生成機能を自社プロダクトから呼び出すための 公開 REST API です。Business プラン契約者向けに提供しています。 Pro 以下でも有効な API キーは作成できますが、レート制限・クレジット消費は 通常のサブスクと共有します。
このページの目次
https://creative.clearnets.org/api/v1Content-Type: application/json)Authorization: Bearer ccs_live_...)すべてのエンドポイントは Authorization: Bearer <ccs_live_...> を要求します。 API キーは /account/api-keys から発行できます。
Authorization: Bearer ccs_live_AbCd123...xyzccs_test_* プレフィックスのキーが発行されます。API キーごとに権限を分けるため、発行時に複数のスコープを選択できます。 スコープ不足の操作には 403 FORBIDDEN_SCOPE を返します。
| Scope | 説明 |
|---|---|
generate | コンテンツ生成 (POST /api/v1/generate) |
read | 履歴の取得 (GET /api/v1/generations, GET /api/v1/generations/:id) |
admin | 全権 (将来用) |
すべてのエラーレスポンスは下記の構造です。 issues は Zod の flatten 出力です。
{
"error": "INVALID_INPUT",
"message": "Request body failed schema validation.",
"issues": { /* zod の flatten 出力 */ }
}| Code | 意味 |
|---|---|
200 | 成功 |
400 | 入力スキーマ違反 (INVALID_INPUT / INVALID_JSON) |
401 | API キーがない/不正 (UNAUTHORIZED) |
402 | クレジット不足 (INSUFFICIENT_CREDITS) |
403 | スコープ不足 (FORBIDDEN_SCOPE) |
404 | リソースが見つからない / 所有権なし (NOT_FOUND) |
422 | 入力モデレーション違反 (INPUT_FORBIDDEN) |
429 | レート制限 (RATE_LIMITED) |
500 | 内部エラー / 出力モデレーション違反 (GENERATION_FAILED / OUTPUT_FORBIDDEN) |
PUBLIC_API_RATE_LIMIT_PER_MIN で上書き可Retry-After, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (epoch sec)| packType | クレジット |
|---|---|
event_announcement | 1 |
product_intro | 1 |
short_video_script | 1 |
ad_creative | 1 |
post_calendar_30 | 10 |
生成失敗・出力モデレーション違反時はクレジットが自動返金されます。 A/B バリアントを Public API から呼ぶ場合 (将来対応) はCREDIT_COST[packType] * count を消費します。
/api/v1/generate — Content Pack を 1 件生成 (スコープ: generate)/api/v1/generations — 履歴の一覧取得 (スコープ: read)/api/v1/generations/:id — 履歴 1 件の取得 (所有者一致、スコープ: read)/api/v1/me — 残高・プラン・有効スコープ取得 (スコープ不問)スコープ: generate。 Content Pack を 1 件生成します。クレジット消費は packType に応じて 1〜10。
Request body (抜粋)
{
"packType": "event_announcement",
"title": "春の新歓イベント",
"target": "大学1〜2年生",
"purpose": "サークル説明会への申込誘導",
"highlight": "現役メンバーとの交流時間あり",
"tone": "明るく親しみやすい",
"cta": "申し込みフォームへ",
"eventDate": "2026-04-12 18:00",
"eventLocation": "本郷キャンパス 工学部1号館",
"signupUrl": "https://example.com/signup",
"brandId": "00000000-0000-0000-0000-000000000000",
"medium": ["instagram", "x"]
}Response (200)
{
"id": "uuid",
"pack_type": "event_announcement",
"created_at": "2026-06-01T12:34:56.789Z",
"credits_used": 1,
"output": { /* ContentPack */ },
"meta": { "model": "gpt-4o", "durationMs": 4321, "mock": false, "degraded": false }
}curl 例
curl -X POST https://creative.clearnets.org/api/v1/generate \
-H "Authorization: Bearer ccs_live_xxx" \
-H "Content-Type: application/json" \
-d '{
"packType": "product_intro",
"title": "新作シャンプー",
"target": "20代女性",
"highlight": "アミノ酸系・無香料"
}'スコープ: read。 自分の生成履歴を新しい順に取得します。
Query
limit (default 20, max 100)cursor (ISO datetime; 前回の next_cursor を渡す)Response
{
"data": [
{
"id": "uuid",
"pack_type": "product_intro",
"created_at": "2026-06-01T12:34:56.789Z",
"status": "succeeded",
"credits_used": 1,
"model_used": "gpt-4o",
"output": { /* ContentPack */ }
}
],
"next_cursor": "2026-05-30T10:00:00.000Z"
}curl 例
curl https://creative.clearnets.org/api/v1/generations?limit=10 \
-H "Authorization: Bearer ccs_live_xxx"スコープ: read、所有者一致のみ。 他人の生成 ID を指定すると 404 NOT_FOUND を返します。
curl https://creative.clearnets.org/api/v1/generations/00000000-... \
-H "Authorization: Bearer ccs_live_xxx"スコープ不問。 自身のプラン・クレジット残高・有効スコープを取得します。 CI で「キーが有効か」を確認するヘルスチェックにも使えます。
Response
{
"user_id": "uuid",
"email": "you@example.com",
"plan": "business",
"credit_balance": 4200,
"scopes": ["generate", "read"]
}/api/v1/* は Access-Control-Allow-Origin: * を返します。 ブラウザから直接叩く場合でも、API キーをクライアントにバンドルしないでください。 キーが漏洩すると残高が消費されます。サーバサイド経由で呼び出してください。