はじめに

Culaly API は、AI の先進的な機能を RESTful API として提供するプラットフォームです。 音声認識・自然言語処理をはじめとする AI 機能を、シンプルな API コールで自社のアプリケーションやワークフローに組み込むことができます。

Culaly API でできること

機能 概要
ASR（音声文字起こし） 音声ファイルをアップロードし、高精度な文字起こし・話者分離・VTT 字幕生成を行います

今後も新しい AI 機能が順次追加される予定です。

認証

すべての API リクエストには API キー が必要です。
リクエスト時に X-API-Key ヘッダへキーを付与してください。

plaintext
X-API-Key: YOUR_API_KEY

API キーはダッシュボードから作成・管理できます。キーは第三者に漏洩しないよう安全に保管してください。

ベース URL

plaintext
https://culaly.com

すべてのエンドポイントは上記ベース URL からの相対パスです。

クイックスタート

1. API キーを取得する

ダッシュボードにログインし、API キーを発行します。取得したキーは環境変数などに安全に保存してください。

2. 最初のリクエストを送信する

以下は cURL で ASR（音声文字起こし）ジョブを作成する例です。

bash
curl -X POST https://culaly.com/api/v1/asr \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "audio=@sample.mp3" \
  -F "language=ja"

レスポンスに含まれる job_id を使って、ジョブの状態確認や結果の取得ができます。

3. 結果を取得する

bash
curl https://culaly.com/api/v1/asr/jobs/{job_id}/result \
  -H "X-API-Key: YOUR_API_KEY"

権限（パーミッション）

API キーにはスコープごとの権限が設定されています。利用する機能に応じて適切な権限を付与してください。

スコープ 説明
asr:transcription:create 文字起こしジョブの作成
asr:transcription:read ジョブ情報・ステータスの参照
asr:storage:download 結果ファイル・音声・VTT のダウンロード

レスポンス形式

API のレスポンスは JSON 形式で返されます（バイナリダウンロード系エンドポイントを除く）。

エラーレスポンス

エラー時は HTTP ステータスコードとともにエラー情報が返されます。

ステータスコード 説明
400 リクエストが不正です
401 認証に失敗しました（API キーが無効または未指定）
403 権限が不足しています
404 リソースが見つかりません
429 レートリミットを超過しました
500 サーバー内部エラー

レート制限

API にはレート制限が設けられています。制限を超えた場合は 429 Too Many Requests が返されます。
レスポンスヘッダの Retry-After を参照し、指定秒数後にリトライしてください。

次のステップ