API ドキュメント

AnimaTime 外部連携 API (v1) のリファレンスです。APIキーは設定ページから発行できます。

認証

全てのリクエストに Bearer トークンが必要です。

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://animatime.com/api/v1/projects

APIキーが無効または期限切れの場合、401 Unauthorized が返ります。

エラーレスポンス

全てのエラーは統一フォーマットで返されます。

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Bearer token required"
  }
}

コード	意味
UNAUTHORIZED	認証エラー
NOT_FOUND	リソースが見つからない
BAD_REQUEST	リクエスト不正
INTERNAL_ERROR	サーバーエラー

ページネーション

一覧系エンドポイントはページネーションをサポートします。

パラメータ	デフォルト	説明
page	1	ページ番号
perPage	20	1ページあたりの件数 (最大100)

エンドポイント

GET/api/v1/projects

プロジェクト一覧を取得

レスポンス

{
  "data": [
    {
      "id": "clxxx...",
      "name": "作品タイトル",
      "description": "説明",
      "createdAt": "2025-01-01T00:00:00.000Z",
      "updatedAt": "2025-01-01T00:00:00.000Z"
    }
  ],
  "pagination": { "page": 1, "perPage": 20, "total": 5 }
}

GET/api/v1/staff

スタッフ一覧を取得

レスポンス

{
  "data": [
    {
      "id": "clxxx...",
      "name": "山田太郎",
      "email": "yamada@example.com",
      "specialties": ["原画", "動画"],
      "createdAt": "2025-01-01T00:00:00.000Z"
    }
  ],
  "pagination": { "page": 1, "perPage": 50, "total": 12 }
}

GET/api/v1/episodes/{id}/cuts

話数のカット一覧を取得

パスパラメータ

話数ID

レスポンス

{
  "data": [
    {
      "id": "clxxx...",
      "number": 1,
      "processes": [
        {
          "id": "clxxx...",
          "type": "GENGA",
          "status": "IN_PROGRESS",
          "assigneeId": "clxxx...",
          "startDate": "2025-01-10",
          "dueDate": "2025-01-20"
        }
      ]
    }
  ]
}

PATCH/api/v1/processes/{id}

工程を更新

リクエストボディ

{
  "status": "COMPLETED",       // optional
  "assigneeId": "clxxx...",    // optional
  "startDate": "2025-01-10",   // optional
  "dueDate": "2025-01-20"      // optional
}

ステータス値

NOT_STARTED | IN_PROGRESS | COMPLETED | RETAKE

PATCH/api/v1/processes/bulk/status

工程を一括ステータス更新

リクエストボディ

{
  "processIds": ["id1", "id2", "id3"],
  "status": "COMPLETED"
}

最大100件まで。

レート制限

レート制限は現在適用されていません。

今後、レート制限の導入を予定しています。導入時にはこちらのページでお知らせします。

ご不明な点はお問い合わせからご連絡ください。