# Обсяг пошуку за ключовими словами AI Keyword Data

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/ai_optimization/ai_keyword_data/keywords_search_volume/live`

**Tags:** DataForSEO

Повертає `location_code`, `language_code`, `items_count` і `items`. Обгорнуто в конверт DataForSEO: дані в `tasks[0].result`, результат у `tasks[0].status_code` — відхилений запит усе одно повертає HTTP 200. Для класичного обсягу пошуку використовуйте `post_dataforseo_keywords_gads_search_volume_live`; ці два показники відповідають на різні питання й часто розходяться.

### Довідкові дані про ціни

- Тарифікація: заявлена вартість відповіді.
- Орієнтовна вартість запиту: USD 0.011.
- Довідковий множник для клієнта: 1.0. Не застосовуйте його повторно до вже розрахованої суми клієнта.

Довідкові метадані, а не котирування для облікового запису, гарантована ціна чи ліміт витрат. Кредити ресурсів — це не кредити Felo. Остаточні списання здійснюються за записами білінгу Felo.

## Related links

- [статті Help Center](<https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis>)
- [тут](<https://dataforseo.com/help-center/what-is-ai-search-volume-in-dataforseo>)

## 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": {
          "keywords": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "<em>keywords</em><br><strong>обов'язкове поле</strong><br>кодування UTF-8<br>максимальна кількість ключових слів: 1000;<br>максимальна кількість символів в одному ключовому слові: 250;<br>ключові слова перетворюються на нижній регістр;<p>Докладніше про правила й обмеження полів <code>keyword</code> і <code>keywords</code> в API DataForSEO читайте в статті Help Center"
          },
          "location_name": {
            "type": "string",
            "description": "<em>повна назва місцезнаходження</em><br><strong>обов'язкове поле, якщо не вказано <code>location_code</code></strong><br><strong>Примітка:</strong> потрібно вказати <code>location_name</code> або <code>location_code</code><br>список доступних місцезнаходжень з їхньою <code>location_name</code> можна отримати окремим запитом до<br><code>https://api.dataforseo.com/v3/ai_optimization/ai_keyword_data/locations_and_languages</code><br>приклад:<br><code class=\"long-string\">United Kingdom</code>"
          },
          "location_code": {
            "type": "integer",
            "description": "<em>унікальний ідентифікатор місцезнаходження</em><br><strong>обов'язкове поле, якщо не вказано <code>location_name</code></strong><br><strong>Примітка:</strong> потрібно вказати <code>location_name</code> або <code>location_code</code><br>список доступних місцезнаходжень з їхнім <code>location_code</code> можна отримати окремим запитом до <br><code>https://api.dataforseo.com/v3/ai_optimization/ai_keyword_data/locations_and_languages</code><br>приклад:<br><code class=\"long-string\">2840</code>"
          },
          "language_name": {
            "type": "string",
            "description": "<em>повна назва мови</em><br><strong>обов'язкове поле, якщо не вказано <code>language_code</code></strong><br><strong>якщо використовуєте це поле, <code>language_code</code> вказувати не потрібно</strong><br>список доступних мов з їхньою <code>language_name</code> можна отримати окремим запитом до<br><code>https://api.dataforseo.com/v3/ai_optimization/ai_keyword_data/locations_and_languages</code><br>приклад:<br><code class=\"long-string\">English</code>"
          },
          "language_code": {
            "type": "string",
            "description": "<em>код мови</em><br><strong>обов'язкове поле, якщо не вказано <code>language_name</code></strong><br><strong>якщо використовуєте це поле, <code>language_name</code> вказувати не потрібно</strong><br>список доступних мов з їхнім <code>language_code</code> можна отримати окремим запитом до<br><code>https://api.dataforseo.com/v3/ai_optimization/ai_keyword_data/locations_and_languages</code><br>приклад:<br><code class=\"long-string\">en</code>"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>визначений користувачем ідентифікатор завдання</em><br>необов'язкове поле<br><em>обмеження — 255 символів</em><br>цей параметр дає змогу ідентифікувати завдання й зіставити його з результатом<br>вказане значення <code>tag</code> ви знайдете в об'єкті <code>data</code> відповіді"
          }
        },
        "example": [
          {
            "language_name": "English",
            "location_code": 2840,
            "keywords": [
              "iphone",
              "seo"
            ]
          }
        ]
      }
    ]
  },
  "example": [
    {
      "language_name": "English",
      "location_code": 2840,
      "keywords": [
        "iphone",
        "seo"
      ]
    }
  ]
}
```

## Responses

### 200 — Успішна операція

Headers:
- `X-Request-Id` (string) — Ідентифікатор запиту, який потрібно вказати під час звернення до підтримки Felo.

**application/json**

Schema: object | null

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

### 400 — Не вдалося обробити запит. Перевірте параметри запиту.

### 401 — Потрібен дійсний API-ключ Felo.

### 402 — Запит неможливо виконати: умови білінгу не виконано.

### 403 — Обліковий запис не має дозволу на цю операцію.

### 429 — Досягнуто ліміту запитів або витрат.

### 502 — Служба не змогла виконати запит.

### 503 — API або служба білінгу тимчасово недоступні.

### 504 — Час очікування обробки запиту вичерпано.

### default — Відповідь із помилкою; наскрізні відповіді апстріму можуть використовувати формати постачальника

**application/json**

Schema:

```json
{}
```

## Schema definitions

### Response36Afe1097B20_AiMonthlySearches

`#/components/schemas/Response36Afe1097B20_AiMonthlySearches`

```json
{
  "type": "object",
  "properties": {
    "year": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>рік</em>"
    },
    "month": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>місяць</em>"
    },
    "ai_search_volume": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>поточний показник обсягу AI-пошуку для ключового слова</em><br>докладніше про цю метрику — тут",
      "format": "int64"
    }
  }
}
```

### Response36Afe1097B20_AiOptimizationAiKeywordDataKeywordsSearchVolumeLiveItem

`#/components/schemas/Response36Afe1097B20_AiOptimizationAiKeywordDataKeywordsSearchVolumeLiveItem`

```json
{
  "type": "object",
  "properties": {
    "keyword": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>зазначене ключове слово</em>"
    },
    "ai_search_volume": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>поточний показник обсягу AI-пошуку для ключового слова</em><br>докладніше про цю метрику — тут",
      "format": "int64"
    },
    "ai_monthly_searches": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_AiMonthlySearches"
          }
        ]
      },
      "description": "<em>щомісячні обсяги AI-пошуку</em><br>масив об'єктів з обсягами AI-пошуку за певний місяць року"
    }
  }
}
```

### Response36Afe1097B20_AiOptimizationAiKeywordDataKeywordsSearchVolumeLiveResponseInfo

`#/components/schemas/Response36Afe1097B20_AiOptimizationAiKeywordDataKeywordsSearchVolumeLiveResponseInfo`

```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_AiOptimizationAiKeywordDataKeywordsSearchVolumeLiveTaskInfo"
              }
            ]
          },
          "description": "<em>масив завдань</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_AiOptimizationAiKeywordDataKeywordsSearchVolumeLiveResultInfo

`#/components/schemas/Response36Afe1097B20_AiOptimizationAiKeywordDataKeywordsSearchVolumeLiveResultInfo`

```json
{
  "type": "object",
  "properties": {
    "location_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>код місцеположення в масиві POST</em>"
    },
    "language_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>код мови в масиві POST</em>"
    },
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>кількість результатів, повернутих у масиві <code>items</code></em>",
      "format": "int64"
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_AiOptimizationAiKeywordDataKeywordsSearchVolumeLiveItem"
          }
        ]
      },
      "description": "<em>містить зазначені ключові слова з їхніми показниками обсягу AI-пошуку</em>"
    }
  }
}
```

### Response36Afe1097B20_AiOptimizationAiKeywordDataKeywordsSearchVolumeLiveTaskInfo

`#/components/schemas/Response36Afe1097B20_AiOptimizationAiKeywordDataKeywordsSearchVolumeLiveTaskInfo`

```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_AiOptimizationAiKeywordDataKeywordsSearchVolumeLiveResultInfo"
              }
            ]
          },
          "description": "<em>масив результатів</em>"
        }
      }
    }
  ]
}
```

### 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": "код стану завдання\nформується DataForSEO, може перебувати в діапазоні 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-запиті"
    }
  }
}
```
