ProAI Sphere API仕様書

API概要
基本情報
バージョン: v1.0.0
ベースURL: https://api.professional-services.ai/v1
認証方式: API Key (Bearer Token)
データ形式: JSON
文字エンコーディング: UTF-8
レート制限
基本プラン: 100リクエスト/分
プロフェッショナル: 1,000リクエスト/分
エンタープライズ: 10,000リクエスト/分
認証

すべてのAPIリクエストには、有効なAPIキーが必要です。APIキーはAuthorizationヘッダーにBearerトークンとして含めてください。

リクエストヘッダー例
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
重要: APIキーは秘密情報として扱い、クライアントサイドのコードに直接埋め込まないでください。
エンドポイント一覧

エンドポイント
POST /v1/documents/generate
説明

各士業専門の法的文書を自動生成します。

リクエストパラメータ
{
  "profession_type": "社労士",
  "document_type": "労働契約書",
  "template_id": "template_001",
  "data": {
    "company_name": "株式会社サンプル",
    "employee_name": "田中太郎",
    "start_date": "2025-04-01",
    "salary": 300000,
    "work_hours": "9:00-18:00"
  },
  "options": {
    "format": "pdf",
    "language": "ja"
  }
}
レスポンス例
{
  "status": "success",
  "document_id": "doc_12345",
  "download_url": "https://api.professional-services.ai/v1/documents/doc_12345/download",
  "expires_at": "2025-06-15T10:30:00Z",
  "metadata": {
    "pages": 3,
    "size_bytes": 245760,
    "format": "pdf"
  }
}

エンドポイント
POST /v1/consultation/ai
説明

専門的な法的相談に対するAI回答を生成します。

リクエストパラメータ
{
  "profession_type": "弁護士",
  "question": "労働問題についての相談です...",
  "context": {
    "case_type": "労働法",
    "urgency": "high",
    "jurisdiction": "日本"
  },
  "options": {
    "include_references": true,
    "language": "ja"
  }
}
レスポンス例
{
  "status": "success",
  "consultation_id": "cons_67890",
  "answer": "ご相談の労働問題について...",
  "confidence_score": 0.92,
  "references": [
    {
      "law": "労働基準法第20条",
      "description": "解雇の予告について"
    }
  ],
  "follow_up_questions": [
    "契約書の内容を確認できますか？",
    "会社からの通知書はありますか？"
  ]
}

エンドポイント
GET /v1/cases/search
説明

関連する判例を検索します。

クエリパラメータ
パラメータ 型 必須 説明
query string ○ 検索キーワード
court string 裁判所名
date_from date 判決日開始
date_to date 判決日終了
limit integer 結果数制限 (デフォルト: 20)
レスポンス例
{
  "status": "success",
  "total_count": 156,
  "results": [
    {
      "case_id": "case_001",
      "title": "労働契約解除事件",
      "court": "最高裁判所",
      "date": "2024-03-15",
      "summary": "労働者の解雇について...",
      "relevance_score": 0.89,
      "url": "https://www.courts.go.jp/..."
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 20,
    "total_pages": 8
  }
}

エンドポイント
POST /v1/compliance/check
説明

文書や契約のコンプライアンス状況をチェックします。

リクエストパラメータ
{
  "document_text": "契約書の本文...",
  "check_types": [
    "labor_law",
    "personal_data_protection",
    "corporate_law"
  ],
  "severity_threshold": "medium"
}
レスポンス例
{
  "status": "success",
  "overall_score": 0.78,
  "issues_found": 3,
  "checks": [
    {
      "type": "labor_law",
      "status": "warning",
      "issues": [
        {
          "severity": "medium",
          "description": "労働時間の記載が不明確です",
          "suggestion": "具体的な労働時間を明記してください",
          "line_number": 15
        }
      ]
    }
  ]
}

ユーザー一覧取得
GET /v1/users
ユーザー作成
POST /v1/users
ユーザー詳細取得
GET /v1/users/{user_id}
ユーザー更新
PUT /v1/users/{user_id}
ユーザー削除
DELETE /v1/users/{user_id}
エラーコード
HTTPステータス エラーコード 説明 対処法
400 INVALID_REQUEST リクエストパラメータが不正 リクエストの形式を確認してください
401 UNAUTHORIZED 認証が必要または無効 有効なAPIキーを設定してください
403 FORBIDDEN アクセス権限がない 必要な権限を確認してください
404 NOT_FOUND リソースが見つからない URLとパラメータを確認してください
429 RATE_LIMIT_EXCEEDED レート制限に達した リクエスト頻度を下げてください
500 INTERNAL_ERROR サーバー内部エラー 時間を置いて再試行してください
SDKとツール
公式SDK
  • Python SDK
  • JavaScript/Node.js SDK
  • PHP SDK
  • Java SDK
  • C# SDK (開発中)
開発ツール
  • Postmanコレクション
  • OpenAPI仕様書
  • インタラクティブAPI Explorer
  • Webhookテストツール
  • レート制限モニター