# SERP API AI 요약

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/serp/ai_summary`

**Tags:** DataForSEO

Google에서 쿼리에 대해 검색 결과 위에 표시하는 AI 개요를 반환합니다. `keyword`, `type`, `se_domain`, `location_code`, `language_code`, `check_url`, `datetime`, `spell`, `refinement_chips`, `item_types`, `items_count`, `items`를 반환합니다. DataForSEO 응답 봉투로 감싸집니다. 데이터는 `tasks[0].result`, 처리 결과는 `tasks[0].status_code`에 있으며, 거부된 요청도 HTTP 200을 반환합니다.

### 가격 참고

- 과금 기준: 응답에 보고된 비용.
- 참고 요청 추정치: USD 0.02.
- 참고 고객 배수: 1.0. 정산된 고객 금액에 다시 적용하지 마세요.

참고용 메타데이터일 뿐이며, 계정 견적 또는 보장된 가격 또는 지출 한도가 아닙니다. 리소스 크레딧은 Felo 크레딧이 아닙니다. 최종 청구는 Felo 청구 기록을 따릅니다.

## Base URL

- `https://openapi.felo.ai`

## Authentication

- `FeloBearerAuth` (http bearer, bearer format Felo API Key)
- `FeloApiKey` (apiKey in header `X-API-Key`)

## Request body

Required: **no**

### application/json

Schema:

```json
{
  "type": "array",
  "items": {
    "type": [
      "object",
      "null"
    ],
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "task_id": {
            "type": "string",
            "description": "<em>작업 식별자</em><br><strong>필수 필드</strong><br><a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> 형식의 연결된 작업 고유 식별자입니다<br><strong>30일</strong> 이내에 언제든지 이 식별자로 작업 결과를 요청할 수 있습니다"
          },
          "prompt": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>AI 프롬프트</em><br>선택 필드<br>AI 요약기를 위한 추가 작업입니다;<br>AI에게 원하는 응답을 전달하는 모든 형태의 텍스트, 질문 또는 정보를 입력할 수 있습니다;<br>지정할 수 있는 최대 기호 또는 문자 수: <code>2000</code>;<br><strong>참고:</strong> 프롬프트는 SERP API에 대한 POST 요청에 지정한 키워드와 관련이 있어야 합니다"
          },
          "support_extra": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>추가 SERP 기능 지원</em><br>선택 필드<br><code>true</code>로 설정하면 AI 모델이 <code>organic</code> 결과 외에 다음 추가 SERP 기능도 고려합니다: <code>answer_box</code>, <code>knowledge_graph</code>, <code>featured_snippet</code>;<br>기본값: <code>true</code>"
          },
          "fetch_content": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>SERP 페이지의 콘텐츠 가져오기</em><br>선택 필드<br><code>true</code>로 설정하면 API가 SERP 결과에 포함된 페이지의 콘텐츠를 가져오고, AI 모델이 결과 요약을 생성할 때 이 콘텐츠를 반영합니다;<br>기본값: <code>false</code>"
          },
          "include_links": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>요약에 출처 링크 포함</em><br>선택 필드<br><code>true</code>로 설정하면 API 응답의 <code>summary</code> 필드에 생성된 요약의 출처 링크가 포함됩니다;<br>기본값: <code>false</code>"
          }
        },
        "example": [
          {
            "task_id": "07031739-1535-0139-0000-9d1e639a5b7d",
            "prompt": "explain what DataForSEO is",
            "include_links": true,
            "fetch_content": true
          }
        ]
      }
    ]
  },
  "example": [
    {
      "task_id": "07031739-1535-0139-0000-9d1e639a5b7d",
      "prompt": "explain what DataForSEO is",
      "include_links": true,
      "fetch_content": true
    }
  ]
}
```

## Responses

### 200 — 작업 성공

Headers:
- `X-Request-Id` (string) — Felo 지원팀에 문의할 때 포함할 요청 식별자입니다.

**application/json**

Schema: object | null

```json
{
  "type": [
    "object",
    "null"
  ],
  "oneOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_SerpAiSummaryResponseInfo"
    }
  ]
}
```

### 400 — 요청을 처리할 수 없습니다. 요청 매개변수를 확인하세요.

### 401 — 유효한 Felo API 키가 필요합니다.

### 402 — 청구 요건이 충족되지 않아 요청을 진행할 수 없습니다.

### 403 — 이 계정에는 이 작업을 수행할 권한이 없습니다.

### 429 — 요청 또는 지출 한도에 도달했습니다.

### 502 — 서비스가 요청을 완료할 수 없습니다.

### 503 — API 또는 청구 서비스를 일시적으로 사용할 수 없습니다.

### 504 — 요청을 처리하는 동안 서비스 시간이 초과되었습니다.

### default — 오류 응답. 업스트림 패스스루 응답은 공급자 형식을 사용할 수 있습니다.

**application/json**

Schema:

```json
{}
```

## Schema definitions

### Response36Afe1097B20_BaseResponseInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseInfo`

```json
{
  "properties": {
    "version": {
      "type": [
        "string",
        "null"
      ],
      "description": "API의 현재 버전"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "일반 상태 코드입니다.\n응답 코드 전체 목록은 여기에서 확인할 수 있습니다."
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "일반 정보 메시지입니다.\n일반 정보 메시지 전체 목록은 여기에서 확인할 수 있습니다."
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "총 실행 시간(초)"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "전체 작업 비용, USD",
      "format": "double"
    },
    "tasks_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "tasks 배열의 작업 수",
      "format": "int64"
    },
    "tasks_error": {
      "type": [
        "integer",
        "null"
      ],
      "description": "오류와 함께 반환된 tasks 배열의 작업 수",
      "format": "int64"
    }
  }
}
```

### Response36Afe1097B20_BaseResponseTaskInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo`

```json
{
  "properties": {
    "id": {
      "type": [
        "string",
        "null"
      ],
      "description": "작업 식별자\n시스템 내 고유 작업 식별자(UUID 형식)"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "작업의 상태 코드\nDataForSEO가 생성하며 10000-60000 범위일 수 있습니다.\n응답 코드 전체 목록은 여기에서 확인할 수 있습니다."
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "작업의 정보 메시지\n일반 정보 메시지 전체 목록은 여기에서 확인할 수 있습니다."
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "실행 시간, 초"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "전체 작업 비용, USD",
      "format": "double"
    },
    "result_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "result 배열의 요소 수",
      "format": "int64"
    },
    "path": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "URL 경로"
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "object",
          "null"
        ]
      },
      "description": "POST 요청에 지정한 것과 동일한 매개변수를 포함합니다"
    }
  }
}
```

### Response36Afe1097B20_SerpAiSummaryItem

`#/components/schemas/Response36Afe1097B20_SerpAiSummaryItem`

```json
{
  "type": "object",
  "properties": {
    "summary": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>생성된 요약</em><br>요청에 지정된 매개변수에 따라 AI 모델이 생성한 요약"
    }
  }
}
```

### Response36Afe1097B20_SerpAiSummaryResponseInfo

`#/components/schemas/Response36Afe1097B20_SerpAiSummaryResponseInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseInfo"
    },
    {
      "type": "object",
      "properties": {
        "tasks": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_SerpAiSummaryTaskInfo"
              }
            ]
          },
          "description": "<em>작업 배열</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_SerpAiSummaryResultInfo

`#/components/schemas/Response36Afe1097B20_SerpAiSummaryResultInfo`

```json
{
  "type": "object",
  "properties": {
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>결과 배열의 항목 수</em>",
      "format": "int64"
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_SerpAiSummaryItem"
          }
        ]
      },
      "description": "<em>항목 배열</em>"
    }
  }
}
```

### Response36Afe1097B20_SerpAiSummaryTaskInfo

`#/components/schemas/Response36Afe1097B20_SerpAiSummaryTaskInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
    },
    {
      "type": "object",
      "properties": {
        "result": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_SerpAiSummaryResultInfo"
              }
            ]
          },
          "description": "<em>결과 배열</em>"
        }
      }
    }
  ]
}
```