---
updatedAt: 2026-04-27T13:22:54.000Z
agentTools:
  projectIndex: https://developers.karte.io/llms.txt
---

# Craft RAG Get Operation

指定されたオペレーションの詳細情報と進行状況を取得します。
#### Required Scope
APIの実行に必要なScopeです。
```
beta.craft.rag.getOperation
```

#### Required Role
管理画面でScopeを追加する際に必要な権限です。
```
Craft > Craft 設定の閲覧
```


# OpenAPI definition

````json
{
  "openapi": "3.0.0",
  "servers": [
    {
      "url": "https://api.karte.io",
      "description": "Production server"
    },
    {
      "url": "https://api-jp.karte.io",
      "description": "Production JP server. リージョン固定オプションのプロジェクトはこちらのエンドポイントを利用してください."
    }
  ],
  "info": {
    "version": "2.0.0",
    "title": "Craft"
  },
  "paths": {
    "/v2beta/craft/rag/getOperation": {
      "post": {
        "tags": [
          "RAG"
        ],
        "summary": "Craft RAG Get Operation",
        "description": "指定されたオペレーションの詳細情報と進行状況を取得します。\n#### Required Scope\nAPIの実行に必要なScopeです。\n```\nbeta.craft.rag.getOperation\n```\n\n#### Required Role\n管理画面でScopeを追加する際に必要な権限です。\n```\nCraft > Craft 設定の閲覧\n```\n",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "corpusId",
                  "path"
                ],
                "additionalProperties": false,
                "properties": {
                  "corpusId": {
                    "type": "string",
                    "description": "RAGコーパスの一意の識別子",
                    "example": "1234567890123456789"
                  },
                  "path": {
                    "type": "string",
                    "description": "操作を取得するためのパスまたは識別子",
                    "example": "/path/to/file.txt"
                  },
                  "siteName": {
                    "type": "string",
                    "description": "パスに関連付けられたサイトの名前",
                    "example": "exampleSite"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Operation retrieved successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "operation": {
                      "type": "object",
                      "additionalProperties": false,
                      "properties": {
                        "filePath": {
                          "type": "string",
                          "description": "Path of the file associated with the operation"
                        },
                        "status": {
                          "type": "string",
                          "description": "Current status of the operation"
                        }
                      },
                      "description": "Details of the operation"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "リクエスト数が上限を超えた場合",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "error"
                  ],
                  "additionalProperties": false
                },
                "example": {
                  "error": "Too many requests"
                }
              }
            }
          }
        },
        "security": [
          {
            "bearer": []
          }
        ],
        "parameters": [
          {
            "in": "header",
            "name": "x-karte-api",
            "schema": {
              "type": "string"
            },
            "description": "今後利用する可能性のある予約語です。現在は設定不要です。"
          },
          {
            "in": "header",
            "name": "authorization",
            "schema": {
              "type": "string"
            },
            "description": "認証情報を含むトークンです。\"Authorization\" ヘッダーに `Bearer <token>` の形式で設定してください。"
          },
          {
            "in": "header",
            "name": "content-type",
            "schema": {
              "type": "string"
            },
            "description": "リクエストのコンテンツタイプを指定します。通常は `application/json` を使用してください。"
          }
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearer": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "x-explorer-enabled": false
}
````