> ## Documentation Index
> Fetch the complete documentation index at: https://www.octoparse.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Octoparse OpenAPI

> Octoparse OpenAPIの認証、タスク管理、クラウド抽出、データエクスポートに関するAPIリファレンスです。

Octoparse OpenAPIを使うと、タスクの管理、クラウド抽出の実行、スクレイピングデータの取得をプログラムから行えます。

## 認証

保護されたエンドポイントでは、Octoparse APIキーを使用するのが最も簡単です。Octoparseアカウントセンターでキーを作成し、リクエストの`x-api-key`ヘッダーに指定します。同じAPIキーをOctoparse OpenAPI、MCP Server、CLIで使用できます。

> [card] [APIキーを作成・管理する](https://www.octoparse.com/console/open-platform/api-keys)
>
> OctoparseアカウントセンターのAPIキーページを開きます。

APIキーは通常`op_sk_`で始まります。

```bash theme={null}
curl "https://openapi.octoparse.com/taskGroup" \
  --header "x-api-key: op_sk_xxxxx"
```

> [!WARNING]
>
> APIキーは秘密情報として管理してください。ブラウザ側のコード、公開リポジトリ、スクリーンショット、ログに含めないでください。

アクセストークン認証も利用できます。`POST /token`でアクセストークンを取得し、`Authorization: Bearer <access_token>`として送信してください。

## AgentTools API

AgentTools APIは、従来のTask API、Cloud Extraction API、Data APIの上に構築された、テンプレート主導のAIエージェント向けワークフローレイヤーです。適切なスクレイピングテンプレートを探し、実行を開始し、サーバーが返す次のアクションに沿って処理を進め、エクスポート情報を取得したい場合に適しています。

新規スクレイピングの基本フロー:

```text theme={null}
searchTemplates -> executeTask -> exportData
```

既存タスクを扱う基本フロー:

```text theme={null}
searchTasks -> startOrStopTask -> exportData
```

AgentToolsを初めて使う場合は、[エンドツーエンドのワークフローチュートリアル](https://helpcenter.octoparse.com/ja/articles/15855832-run-a-scraping-workflow-with-the-octoparse-agenttools-api)で、テンプレート検索から実行、エクスポートまでの流れを確認できます。

AgentToolsの業務データは`data`に含まれます。`requestId`はトラブルシューティング用です。ポーリング間隔を固定せず、`retryGuidance`、`suggestedNextCall`、`workflow`、`toolHint`に従って処理を進めてください。

> [!NOTE]
>
> AgentTools APIでは`x-api-key`認証が必須です。一部のエンドポイントでは`x-external-user-id`も必要です。必要なヘッダーは各エンドポイントのリファレンスを確認してください。

## ご利用前の確認

Octoparse OpenAPIを利用するには、**スタンダード、プロフェッショナル、エンタープライズ**のいずれかのプランで、稼働可能なタスクが少なくとも1つ必要です。アカウントをお持ちでない場合は[こちらから登録](https://www.octoparse.com/signup)できます。

現在のAPIバージョン: **v1.0**

## ベースURL

すべてのリクエストは、次のベースURLに対して送信します。

```text theme={null}
https://openapi.octoparse.com
```

プレースホルダーは`{xxxx}`で表記されており、実際の値に置き換えて使用します。たとえば、タスク検索のリクエストURLは次のとおりです。

```text theme={null}
GET https://openapi.octoparse.com/task/search?taskGroupId={taskGroupId}
```

`taskGroupId`が`abc`の場合、URLは`https://openapi.octoparse.com/task/search?taskGroupId=abc`になります。

## レート制限

Octoparse APIの利用上限は**1秒あたり20リクエスト**です。`429`ステータスコードが返された場合は、リクエスト頻度を下げてください。

成功時のHTTPステータスコードは`200`です。それ以外のステータスについては、各エンドポイントのリファレンスを確認してください。

## 利用可能なプラン

各サービスを利用するには、対応するプランが必要です。利用できない場合は、プランのアップグレードをご検討ください。

| サービス | API | 必要プラン |
| - | - | - |
| アクセストークン | 新しいトークンを取得 | 全ユーザー |
| アクセストークン | リフレッシュトークン | 全ユーザー |
| タスクグループ | タスクグループ情報を取得 | スタンダード、プロフェッショナル、エンタープライズ |
| タスク | タスク検索 | スタンダード、プロフェッショナル、エンタープライズ |
| タスク | タスクを複製 | スタンダード、プロフェッショナル、エンタープライズ |
| タスク | タスクを移動 | スタンダード、プロフェッショナル、エンタープライズ |
| タスク | アクションパラメータを取得 | プロフェッショナル、エンタープライズ |
| タスク | タスクパラメータを更新 | プロフェッショナル、エンタープライズ |
| タスク | アクションパラメータを更新 | プロフェッショナル、エンタープライズ |
| タスク | ループアイテムリストを更新 | プロフェッショナル、エンタープライズ |
| タスク | タスクURLを更新 | プロフェッショナル、エンタープライズ |
| クラウド抽出 | タスクを開始 | プロフェッショナル、エンタープライズ |
| クラウド抽出 | タスクを停止 | プロフェッショナル、エンタープライズ |
| クラウド抽出 | タスクステータスを取得 | プロフェッショナル、エンタープライズ |
| クラウド抽出 | タスクステータスを取得 V2 | プロフェッショナル、エンタープライズ |
| クラウド抽出 | サブタスクのステータスを取得 | プロフェッショナル、エンタープライズ |
| クラウド抽出 | サブタスクを一括実行 | プロフェッショナル、エンタープライズ |
| クラウド抽出 | サブタスクを一括停止 | プロフェッショナル、エンタープライズ |
| データ | 未エクスポートデータを取得 | スタンダード、プロフェッショナル、エンタープライズ |
| データ | データをエクスポート済みとしてマーク | スタンダード、プロフェッショナル、エンタープライズ |
| データ | オフセットによるデータ取得 | スタンダード、プロフェッショナル、エンタープライズ |
| データ | 指定位置からタスクバッチデータを取得 | スタンダード、プロフェッショナル、エンタープライズ |
| データ | データを削除 | スタンダード、プロフェッショナル、エンタープライズ |

## トラブルシューティング

すべてのレスポンスには`requestId`が含まれます。リクエストが失敗した場合は、`requestId`を[Octoparseサポートチーム](mailto:support@octoparse.com)に共有すると、原因調査に役立ちます。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.