### Get Project Positions API Request Example

Source: https://tools.pixelplus.ru/api/doc/positions

This is an example of a GET request to the positions/get method. Ensure you replace 'testtoken' with your actual API token and provide valid project and update IDs.

```http
https://tools.pixelplus.ru/projects/api/v1/positions/get?token=testtoken&project_id=990&update_id=21762
```

--------------------------------

### Uptime API Request Example

Source: https://tools.pixelplus.ru/api/doc/uptime

This is an example of a GET request to the uptime API to retrieve data for a specific project over a week. Ensure you replace 'testtoken' with your actual API token and '990' with the correct project ID.

```http
https://tools.pixelplus.ru/projects/api/v1/uptime/get?token=testtoken&project_id=990&period=week
```

--------------------------------

### Competitors API Request Example

Source: https://tools.pixelplus.ru/api/doc/competitors

Example of a GET request to the competitors API to retrieve positions for a specific project. Includes parameters for token, project ID, date range, search system, and competitor types.

```http
tools.pixelplus.ru/projects/api/v1/competitors/get?token=testtoken&project_id=990&from=2025-03-01&to=2025-03-18&search_system_id=all&types[]=primary&types[]=direct&types[]=indirect
```

--------------------------------

### Get Groups List API Request Example

Source: https://tools.pixelplus.ru/api/doc/groups

This is an example of a GET request to the 'groups/get' endpoint to retrieve a list of groups associated with a specific project. Ensure you include your access token and the project ID.

```http
https://tools.pixelplus.ru/projects/api/v1/groups/get?token=testtoken&project_id=990
```

--------------------------------

### Project API Response Example

Source: https://tools.pixelplus.ru/api/doc/projects

Example JSON response when requesting project information. Shows project ID, domain, status, and update date.

```JSON
{
        "id": "1",
        "name": "",
        "domain": "tools.pixelplus.ru",
        "main_mirror": "https:\/\/tools.pixelplus.ru\/",
        "aliases": "",
        "date_update": "2022-09-06 01:10:43",
        "status": "1"
}
```

--------------------------------

### Vozrast Method API Request Example

Source: https://tools.pixelplus.ru/api/doc/vozrast

This example demonstrates how to construct a request to the 'vozrast' API method to create a report. It includes the API key and a list of URLs to be checked. The response contains a report ID for fetching results.

```json
{
  "key": "your_api_key",
  "requests": [
    "https://example.com/page1",
    "https://example.com/page2"
  ],
  "age_saved_doc": 1,
  "google_check": 0
}
```

--------------------------------

### Get Search Systems

Source: https://tools.pixelplus.ru/api/doc/search-systems

Retrieves a list of search systems configured for a given project. Access is through a GET request to the API.

```APIDOC
## GET /projects/api/v1/search-systems/get

### Description
Retrieves search systems associated with a specific project.

### Method
GET

### Endpoint
`https://tools.pixelplus.ru/projects/api/v1/search-systems/get`

### Parameters
#### Query Parameters
- **token** (string) - Required - Your access token.
- **project_id** (int) - Required - The ID of the project.

### Request Example
`https://tools.pixelplus.ru/projects/api/v1/search-systems/get?token=testtoken&project_id=990`

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the request (e.g., "ok").
- **code** (int) - A code representing the success or failure of the operation.
- **msg** (string) - A message describing the result of the operation.
- **result** (object) - Contains the project details and the list of search systems.
  - **project** (string) - The ID of the project.
  - **search_systems** (array) - A list of search systems.
    - **id** (int) - The ID of the search system.
    - **name** (string) - The name of the search system (e.g., "Яндекс (Москва)").
    - **is_priority** (int) - Indicates if the search system is a priority (1 for yes, 0 for no).
    - **region** (object) - Information about the region.
      - **id** (string) - The ID of the region.
      - **name** (string) - The name of the region.
    - **engine** (object) - Information about the search engine.
      - **id** (string) - The ID of the engine.
      - **name** (string) - The name of the engine.
      - **alias** (string) - An alias for the engine (e.g., "yandex").

#### Response Example
```json
{
  "status": "ok",
  "code": 1,
  "msg": "success",
  "result": {
    "project": "45956",
    "search_systems": [
      {
        "id": 1,
        "name": "Яндекс (Москва)",
        "is_priority": 1,
        "region": {
          "id": "213",
          "name": "Москва"
        },
        "engine": {
          "id": "1",
          "name": "Яндекс",
          "alias": "yandex"
        }
      }
    ]
  }
}
```
```

--------------------------------

### Analiztopv2 API Response - Success Example

Source: https://tools.pixelplus.ru/api/doc/analiztopv2

This is an example of a successful response from the analiztopv2 API after analysis is complete. It includes detailed request parameters and comprehensive response data for both user and top data.

```json
{
"request":
{
 "query":"заданный_запрос",
 "lr":"213",
 "deep":"5",
 "url":"заданный_url",
 "user_urls":"пользовательские_url",
 "search_system":"id_поисковой_системы"
} 
"response":
{
 "user_data":
  {
   "text_volume":{"words":"Количество слов","symbols":"Количество символов"},
   "query_in_text_exact":"Количество точных вхождений запроса в текст",
   "query_words_in_text_percent":[{"word":"слово","percent":1}],
   "query_words_in_title":[{"words":"слово","count":1}],
   "query_words_in_anchors":[{"word":"слово","count":10}],
   "hlwords_in_text":[{"word":"слово","percent":1},{"word":"слово2","percent":0.8}],
   "popular_words":["слово1","слово2","слово3","слово4","слово5","слово6","слово7"],
   "rel_docs_by_title":"Число релевантных документов по тегу Title",
   "title_volume":{"words":19,"symbols":140},
   "tcy":"375",
  "https":true или false,
   "8800":true или false,
  },
 "top_data":
  {
   "text_volume": {
   "text_volume":{"words":879,"symbols":6870},
   "query_in_text_exact":5,
   "query_words_in_text_percent":[{"word":"слово","percent":1}],
   "query_words_in_title":[{"words":"слово","count":1}],
   "query_words_in_anchors":[{"word":"слово","count":10}],
   "hlwords_in_text":[{"word":"слово","percent":1},{"word":"слово2","percent":0.8}],
   "popular_words":["слово1","слово2","слово3","слово4","слово5","слово6","слово7"],
   "rel_docs_by_title":"1338",
   "title_volume":{"words":19,"symbols":140},
   "tcy":"375",
   "8800":75 (в процентах),
   "https":true
  },
 "advanced_data":
  {
   "query":"запрос",
   "rel_url":"Релвантный url",
   "rel_url_current_position":21,
   "rel_url_age":"Возраст релевантного url",
   "reoptimization":"0%",
   "analized_url":"Проанализированный url",
   "analized_url_age":"Возраст проанализированного url"
  },
 "analized_urls":["url1","url2","url3","url4","url5"]
 }
}
```

--------------------------------

### Search Systems API Response Example

Source: https://tools.pixelplus.ru/api/doc/search-systems

This is an example of the JSON response structure when successfully retrieving search system data. It includes project details, search system configurations, and associated regions and engines.

```json
{
  "status": "ok",
  "code": 1,
  "msg": "success",
  "result": {
    "project": "45956",
    "search_systems": [
      {
        "id": 1,
        "name": "Яндекс (Москва)",
        "is_priority": 1,
        "region": {
          "id": "213",
          "name": "Москва"
        },
        "engine": {
          "id": "1",
          "name": "Яндекс",
          "alias": "yandex"
        }
      },
      {
        "id": 5,
        "name": "Яндекс (Санкт-Петербург)",
        "is_priority": 0,
        "region": {
          "id": "2",
          "name": "Санкт-Петербург"
        },
        "engine": {
          "id": "1",
          "name": "Яндекс",
          "alias": "yandex"
        }
      },
      {
        "id": 324,
        "name": "Яндекс (мобильный) (Москва)",
        "is_priority": 0,
        "region": {
          "id": "213",
          "name": "Москва"
        },
        "engine": {
          "id": "7",
          "name": "Яндекс (мобильный)",
          "alias": "yandex-mobile"
        }
      },
      {
        "id": 326,
        "name": "Яндекс (мобильный) (Санкт-Петербург)",
        "is_priority": 0,
        "region": {
          "id": "2",
          "name": "Санкт-Петербург"
        },
        "engine": {
          "id": "7",
          "name": "Яндекс (мобильный)",
          "alias": "yandex-mobile"
        }
      }
    ]
  }
}
```

--------------------------------

### podskazkiyoutube Method

Source: https://tools.pixelplus.ru/api/doc/podskazkiyoutube

API for parsing YouTube suggestions. It allows creating a task to parse YouTube suggestions by sending a request with mandatory GET parameters. The system queues the task and returns a report ID. To get the result, send a GET request with the key and report ID.

```APIDOC
## GET /api/podskazkiyoutube

### Description
API for parsing YouTube suggestions. This method allows you to create a task for parsing YouTube suggestions. To create a task, you need to form a request and send it to the method URL with mandatory GET parameters required to start the task. The system will queue the task and return a report ID. To get the result of the check, send a GET request with the parameters _key_ and _report_id_.

### Method
GET

### Endpoint
https://tools.pixelplus.ru/api/podskazkiyoutube

### Parameters
#### Query Parameters
**1. Mandatory Parameters:**
- **key** (string) - Required - Access key to the API.
- **report_id** (integer) - Required - Report number with YouTube suggestions.
- **request** (string) - Required - Request for parsing.

**2. Optional Parameters:**
- **region** (string) - Optional - Region (RU, UA, BY, KZ).
- **deep** (integer) - Optional - Depth (from 1 to 3, default is 1).
- **stop_list** (string) - Optional - Stop words separated by commas.
- **cb_with_space** (string) - Optional - With a space and without after the phrase (e.g., 'on').
- **cb_with_cyrillic** (string) - Optional - With a permutation of the Cyrillic alphabet (e.g., 'on').
- **cb_with_numbers** (string) - Optional - With a permutation of numbers (e.g., 'on').
- **cb_with_english** (string) - Optional - With a permutation of the English alphabet (e.g., 'on').

### Response
#### Success Response (Task Creation)
- **report_id** (integer) - The ID of the created report.

#### Success Response (Processing)
- **request** (object) - Input parameters.
- **response** (object) - Tool response.
  - **warning_text** (string) - Warning text.
  - **count_words** (object) - Number of words for each phrase (e.g., {"phrase 1": word_count1, "phrase 2": word_count2}).
  - **count_phrases** (integer) - Total number of phrases.
  - **excess_requests_flag** (boolean) - Flag indicating if limits were exceeded.
  - **not_parsed_phrases** (array) - Phrases for which parsing was not performed.

#### Error Responses
- {"query":"Not set","code":-50} - If the parsing request is not set.
- {"request":"Not set","code":-50} - If the parsing request is not set.
- {"error":"error","code":-4} - If an invalid report_id is provided.
- {"error":"In progress","code":50} - If the check for the report_id is still in progress.
- {"error":"In progress","code":-32,"report_id":number} - When attempting to start the tool while a previous check is not yet complete.
- {"error":"access denided","code":-1} - If the access key is not set.
- {"error":"access denided","code":-2} - If the access key is incorrect.
- {"error":"unknown method","code":-3} - If the method name is incorrect.
- {"error":"Not enough daily limits","code":-68} - Not enough daily limits.
- {"error":"Not enough hourly limits","code":-80} - Not enough hourly limits.
- {"error":"Not enough weekly limits","code":-81} - Not enough weekly limits.
- {"error":"Not enough monthly limits","code":-82} - Not enough monthly limits.
- {"error":"Not enough yearly limits","code":-83} - Not enough yearly limits.
- {"error":"Processing error","code":-104} - The tool finished with a fatal error.
- {"error":"Limits run out","code":-105} - Limits ran out during tool execution.
- {"error":"The process was canceled by a user","code":-106} - The task was canceled by the user.
- {"error":"The process took more than 6 hours and was canceled","code":-107} - The tool ran in the background for too long and the process was automatically terminated.
- {"error":"Processing error":-125} - Unexpected error.

### Request Example
**GET:**
`https://tools.pixelplus.ru/api/podskazkiyoutube?key=API_KEY&request=пример&region=RU&deep=1&cb_with_space=on&stop_list=пример1,пример2`
```

--------------------------------

### Vozrast Method Report Retrieval Example

Source: https://tools.pixelplus.ru/api/doc/vozrast

This example shows how to retrieve the results of a 'vozrast' API report using the provided report ID. It requires the API key and the report ID obtained from the initial request.

```json
{
  "key": "your_api_key",
  "report_id": "your_report_id"
}
```

--------------------------------

### Vozrast Method Error Response Examples

Source: https://tools.pixelplus.ru/api/doc/vozrast

These examples illustrate various error responses from the 'vozrast' API method, indicating issues such as missing parameters, exceeding request limits, or invalid API keys.

```json
{"requests":"Not set","code":-50}
```

```json
{"error":"To much requests","code":"-67"}
```

```json
{"error":"Not enough daily limits","code":-68}
```

```json
{"error":"Not enough hourly limits","code":-80}
```

```json
{"error":"Not enough weekly limits","code":-81}
```

```json
{"error":"Not enough monthly limits","code":-82}
```

```json
{"error":"Not enough yearly limits","code":-83}
```

```json
{"error":"access denided","code":-1}
```

```json
{"error":"access denided","code":-2}
```

```json
{"error":"unknown method","code":-3}
```

--------------------------------

### Get Project Information

Source: https://tools.pixelplus.ru/api/doc/projects

Use this method to retrieve details about a specific project. Requires a valid API token.

```HTTP
https://tools.pixelplus.ru/projects/api/v1/projects/get?token=testtoken
```

--------------------------------

### Generate Image with Nano Banana Pro (High Resolution)

Source: https://tools.pixelplus.ru/api/doc/aiimages

This example demonstrates generating an image with Nano Banana Pro at a high resolution. Specify 'resolution' (e.g., '4K') and the desired aspect ratio.

```json
{
  "modelName": "nano-banana-pro",
  "request_field": "портрет в масляной живописи",
  "part": "chat_bot",
  "resolution": "4K",
  "aspect_ratio": "1:1"
}
```

--------------------------------

### Analiztopv2 API Error - Access Denied (No Key)

Source: https://tools.pixelplus.ru/api/doc/analiztopv2

This JSON indicates an error because the API access key was not provided.

```json
{"error":"access denided","code":-1}
```

--------------------------------

### Get Generation Status

Source: https://tools.pixelplus.ru/api/doc/aiimages

This example shows how to retrieve the status of an image generation task using its report ID.

```APIDOC
## GET /api/aiimages

### Description
Retrieves the status and results of a previously submitted image generation task.

### Method
GET

### Endpoint
https://tools.pixelplus.ru/api/aiimages?key={key}&report_id={report_id}

### Parameters
#### Query Parameters
- **key** (string) - Required - Your API key.
- **report_id** (string) - Required - The ID of the report to retrieve.

### Response
#### Success Response (200)
- **status** (string) - The status of the generation task (e.g., 'processing', 'completed', 'failed').
- **result_url** (string) - URL to the generated image(s) if the task is completed.
- **error_message** (string) - Description of the error if the task failed.
```

--------------------------------

### Get Groups List API Response Example

Source: https://tools.pixelplus.ru/api/doc/groups

This JSON structure represents the expected response when successfully calling the 'groups/get' API method. It returns an array of group objects, each with an 'id' and 'name'.

```json
[
{
"id":"22150",
"name":"Tools"
}
]
```

--------------------------------

### Generate Image with Leonardo Model

Source: https://tools.pixelplus.ru/api/doc/aiimages

This example shows how to generate an image using the Leonardo model. It includes parameters for the image prompt, photo realism, aspect ratio, and the number of images to generate.

```APIDOC
## POST /api/aiimages

### Description
Generates an image based on a text prompt using the specified AI model.

### Method
POST

### Endpoint
https://tools.pixelplus.ru/api/aiimages?key={key}

### Parameters
#### Request Body
- **request_field** (string) - Required - The text prompt for image generation.
- **photoReal** (string) - Optional - Enables photo-realistic generation ('on' to enable).
- **aspect_ratio** (string) - Optional - The desired aspect ratio (e.g., '1:1').
- **imagesCount** (string) - Optional - The number of images to generate.
- **modelName** (string) - Required - The name of the AI model to use (e.g., 'leonardo').

### Request Example
```json
{
  "request_field": "Цири из \"Ведьмак 3\" в Каер Морхене, борющаяся с Дикой Охотой, динамичная сцена боя, детализированное изображение, фэнтезийный стиль, насыщенные цвета, заснеженный пейзаж в фоне.",
  "photoReal": "on",
  "aspect_ratio": "1:1",
  "imagesCount": "1",
  "modelName": "leonardo"
}
```
```

--------------------------------

### Wordstat API Response Example

Source: https://tools.pixelplus.ru/api/doc/wordstatapi

Example of a successful JSON response from the Wordstat API containing frequency data for keywords.

```APIDOC
### Response Example
```json
{
  "Запрос 1": {
    "213": {
      "from": "Исходная фраза",
      "overall": 156533,
      "exact": 1233,
      "quoted": 4214,
      "exact_fixed": 12423,
      "frequency_relations": -1
    }
  },
  "Запрос 2": {
    "213": {
      "from": "Исходная фраза",
      "overall": 73022,
      "exact": 1234,
      "quoted": 4123,
      "exact_fixed": 2412,
      "frequency_relations": -1
    }
  }
}
```
```

--------------------------------

### Generate Image with Midjourney and Reference

Source: https://tools.pixelplus.ru/api/doc/aiimages

This example shows how to generate an image with Midjourney using a reference image. Set 'part' to 'with_image', provide the 'image_url', and specify the reference type using 'img_ref'.

```json
{
  "modelName": "midjourney --v 6.1",
  "request_field": "персонаж в киберпанк стиле",
  "part": "with_image",
  "image_url": "https://example.com/reference.png",
  "img_ref": "cref",
  "aspect_ratio": "1:1"
}
```

--------------------------------

### Get Uptime Data

Source: https://tools.pixelplus.ru/api/doc/uptime

Retrieves uptime data for a specific project over a defined period. The API is accessed via a GET request.

```APIDOC
## GET /projects/api/v1/uptime/get

### Description
Retrieves uptime data for a specific project.

### Method
GET

### Endpoint
https://tools.pixelplus.ru/projects/api/v1/uptime/get

### Parameters
#### Query Parameters
- **token** (string) - Required - Access token.
- **project_id** (int) - Required - The ID of the project.
- **period** (string) - Optional - The time period for the data. Accepts 'day' (last 24 hours, default), 'week' (last 7 days), 'two_weeks' (last 14 days), 'month' (last 30 days).

### Request Example
https://tools.pixelplus.ru/projects/api/v1/uptime/get?token=testtoken&project_id=990&period=week

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the request ('ok' or 'error').
- **code** (int) - A code representing the status (1 for success).
- **msg** (string) - A message describing the result ('success' or an error message).
- **result** (array) - An array of objects, each containing:
  - **date** (string) - The date for the uptime data.
  - **percent** (int) - The uptime percentage for that date.

#### Response Example
```json
{
  "status": "ok",
  "code": 1,
  "msg": "success",
  "result": [
    {
      "date": "2025-05-01",
      "percent": 100
    },
    {
      "date": "2025-05-02",
      "percent": 100
    }
  ]
}
```
```

--------------------------------

### Get Project Positions

Source: https://tools.pixelplus.ru/api/doc/positions

Retrieves the positions of projects based on specified parameters. Access is via a GET request to the positions group.

```APIDOC
## GET /projects/api/v1/positions/get

### Description
Retrieves project positions with optional filtering by project, update, group, and limit.

### Method
GET

### Endpoint
https://tools.pixelplus.ru/projects/api/v1/positions/get

### Parameters
#### Query Parameters
- **token** (string) - Required - Access token.
- **project_id** (int) - Required - The ID of the project.
- **update_id** (int) - Optional - The ID of the update.
- **group_id** (int) - Optional - The ID of the group.
- **limit** (int) - Optional - The number of results to return.
- **offset** (int) - Optional - The number of results to skip.

### Request Example
https://tools.pixelplus.ru/projects/api/v1/positions/get?token=testtoken&project_id=990&update_id=21762

### Response
#### Success Response (200)
Returns an array of objects, each containing position details.
- **position** (string) - The ranking position.
- **id** (string) - The unique identifier for the position entry.
- **rel_url** (string) - The relative URL associated with the position.
- **query** (string) - The search query.
- **group_id** (string) - The ID of the group the query belongs to.
- **ss_id** (string) - The search system ID.
- **update_id** (string) - The ID of the update.
- **search_system_id** (string) - The ID of the search system.
- **region** (string) - The region ID.
- **region_name** (string) - The name of the region.
- **frequency** (string) - The search frequency for the query.

#### Response Example
```json
[
{
"position":"1",
"id":"8797228",
"rel_url":"https:\/\/tools.pixelplus.ru\/",
"query":"pixeltools \u0438\u043d\u0441\u0442\u0440\u0443\u043c\u0435\u043d\u0442\u044b",
"group_id":"1",
"ss_id":"1",
"update_id":"21762",
"search_system_id":"1",
"region":"213",
"region_name":"\u041c\u043e\u0441\u043a\u0432\u0430",
"frequency": "554"
},
{
"position":"1",
"id":"8797229",
"rel_url":"https:\/\/tools.pixelplus.ru\/",
"query":"pixeltools.ru",
"group_id":"1",
"ss_id":"1",
"update_id":"21762",
"search_system_id":"1",
"region":"213",
"region_name":"\u041c\u043e\u0441\u043a\u0432\u0430",
"frequency": "554"
}
]
```
```

--------------------------------

### Get Project Groups

Source: https://tools.pixelplus.ru/api/doc/groups

Retrieves a list of groups associated with a specific project ID. The API is accessed via a GET request.

```APIDOC
## GET /projects/api/v1/groups/get

### Description
Retrieves a list of groups for a given project ID.

### Method
GET

### Endpoint
https://tools.pixelplus.ru/projects/api/v1/groups/get

### Parameters
#### Query Parameters
- **token** (string) - Required - Your API access token.
- **project_id** (int) - Required - The ID of the project in the system.

### Request Example
https://tools.pixelplus.ru/projects/api/v1/groups/get?token=testtoken&project_id=990

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the group.
- **name** (string) - The name of the group.

#### Response Example
```json
[
  {
    "id": "22150",
    "name": "Tools"
  }
]
```
```

--------------------------------

### Analiztopv2 API Error - Access Denied (Invalid Key)

Source: https://tools.pixelplus.ru/api/doc/analiztopv2

This JSON indicates an error because an invalid API access key was provided.

```json
{"error":"access denided","code":-2}
```

--------------------------------

### Geo API - GET Request

Source: https://tools.pixelplus.ru/api/doc/geo

Use GET requests to retrieve a report ID for processing. Requires an API key and a report ID.

```APIDOC
## GET /api/geo

### Description
Retrieves a report ID for processing geo-dependency and localization requests.

### Method
GET

### Endpoint
https://tools.pixelplus.ru/api/geo

### Parameters
#### Query Parameters
- **_key** (string) - Required - API access key.
- **_report_id** (string) - Required - Report number with intent.
```

--------------------------------

### Project Information API Response

Source: https://tools.pixelplus.ru/api/doc/project

Example JSON response when fetching project details. Indicates the project's domain, main mirror, aliases, and status.

```JSON
{
"domain":"tools.pixelplus.ru",
"main_mirror":"https:\/\/tools.pixelplus.ru\/",
"aliases":"",
"status":"1"
}
```

--------------------------------

### Complex Queries Analyzer - GET Method

Source: https://tools.pixelplus.ru/api/doc/complex_queries_analyser

Use the GET method to retrieve analysis results using a report ID. Requires an access key and a report ID.

```APIDOC
## GET /complex_queries_analyser

### Description
Retrieves analysis results for a previously generated report.

### Method
GET

### Endpoint
https://tools.pixelplus.ru/api/complex_queries_analyser

### Parameters
#### Query Parameters
- **_key** (string) - Required - API access key.
- **_report_id** (integer) - Required - The ID of the report to retrieve.
```

--------------------------------

### Generate Image with DALL-E 3 Model

Source: https://tools.pixelplus.ru/api/doc/aiimages

This example demonstrates how to generate an image using the DALL-E 3 model. It requires the image prompt and the number of images.

```APIDOC
## POST /api/aiimages

### Description
Generates an image based on a text prompt using the DALL-E 3 model.

### Method
POST

### Endpoint
https://tools.pixelplus.ru/api/aiimages?key={key}

### Parameters
#### Request Body
- **request_field** (string) - Required - The text prompt for image generation.
- **imagesCount** (string) - Optional - The number of images to generate.
- **modelName** (string) - Required - The name of the AI model to use ('dalle').

### Request Example
```json
{
  "request_field": "Цири из \"Ведьмак 3\" в Каер Морхене, борющаяся с Дикой Охотой, динамичная сцена боя, детализированное изображение, фэнтезийный стиль, насыщенные цвета, заснеженный пейзаж в фоне.",
  "imagesCount": "1",
  "modelName": "dalle"
}
```
```

--------------------------------

### Replace Background

Source: https://tools.pixelplus.ru/api/doc/aiimages

This example shows how to replace the background of an image. It requires a prompt, the operation type, and the URL of the image to modify.

```APIDOC
## POST /api/aiimages

### Description
Replaces the background of an image based on a text prompt and a provided image URL.

### Method
POST

### Endpoint
https://tools.pixelplus.ru/api/aiimages?key={key}

### Parameters
#### Request Body
- **request_field** (string) - Required - The text prompt describing the new background.
- **part** (string) - Required - The operation type, must be 'replace_background'.
- **image_url** (string) - Required - The URL of the image whose background needs to be replaced.

### Request Example
```json
{
  "request_field": "Заснеженный ночной лес",
  "part": "replace_background",
  "image_url": "https://i.pinimg.com/originals/40/ff/2b/40ff2b9c8dcfbda6c9b5fe7c0dafbaf4.jpg"
}
```
```

--------------------------------

### Create Analysis Task

Source: https://tools.pixelplus.ru/api/doc/analiztopv2

To create a task, send a GET request to the API URL with mandatory GET parameters. The system will queue the task and return a report ID.

```APIDOC
## POST https://tools.pixelplus.ru/api/analiztopv2

### Description
Creates a new task for analyzing search engine results.

### Method
GET

### Endpoint
https://tools.pixelplus.ru/api/analiztopv2

### Parameters
#### Query Parameters
- **key** (string) - Required - API access key.
- **query** (string) - Required - The search query for analysis.
- **lr** (integer) - Required - The region code for Yandex search.
- **report_id** (integer) - Optional - Report ID to retrieve results for a previously submitted task.
- **url** (string) - Optional - The URL to check.
- **search_system** (integer) - Optional - ID of the search system (1 for Yandex, 2 for Google). Defaults to 1.
- **deep** (integer) - Optional - Depth of analysis (1 to 20).
- **rel_url** (integer) - Optional - Determine relevant URL (1).

#### Request Body
- **custom_urls** (array of strings) - Optional - An array of custom URLs for comparison (1 to 20). If provided, ranking factors are compared against this list and the promoted URL.

### Response
#### Success Response (200)
- **report_id** (integer) - The ID of the generated report.

#### Response Example
```json
[{"report_id":"12345"}]
```

#### Error Responses
- `{"error":"Not enough daily limits","code":-68}` - Insufficient daily limits.
- `{"error":"Not enough hourly limits","code":-80}` - Insufficient hourly limits.
- `{"error":"Not enough weekly limits","code":-81}` - Insufficient weekly limits.
- `{"error":"Not enough monthly limits","code":-82}` - Insufficient monthly limits.
- `{"error":"Not enough yearly limits","code":-83}` - Insufficient yearly limits.
- `{"error":"access denided","code":-1}` - Access denied (invalid key).
- `{"error":"access denided","code":-2}` - Access denied (invalid key format).
- `{"error":"unknown method","code":-3}` - Unknown method.
- `{"error":"Processing error","code":-104}` - Fatal processing error.
- `{"error":"Limits run out","code":-105}` - Limits exhausted during processing.
- `{"error":"The process was canceled by a user","code":-106}` - Process canceled by user.
- `{"error":"The process took more than 6 hours and was canceled","code":-107}` - Process canceled due to exceeding 6 hours.
- `{"error":"Processing error":-125}` - Unexpected error.
```

--------------------------------

### Generate Image with Midjourney 6 Model

Source: https://tools.pixelplus.ru/api/doc/aiimages

This example shows how to generate an image using the Midjourney 6 model. It requires the image prompt and allows specifying the aspect ratio.

```APIDOC
## POST /api/aiimages

### Description
Generates an image based on a text prompt using the Midjourney 6 model.

### Method
POST

### Endpoint
https://tools.pixelplus.ru/api/aiimages?key={key}

### Parameters
#### Request Body
- **request_field** (string) - Required - The text prompt for image generation.
- **aspect_ratio** (string) - Optional - The desired aspect ratio (e.g., '1:1').
- **modelName** (string) - Required - The name of the AI model to use ('midjourney').

### Request Example
```json
{
  "request_field": "Цири из \"Ведьмак 3\" в Каер Морхене, борющаяся с Дикой Охотой, динамичная сцена боя, детализированное изображение, фэнтезийный стиль, насыщенные цвета, заснеженный пейзаж в фоне.",
  "aspect_ratio": "1:1",
  "modelName": "midjourney"
}
```
```

--------------------------------

### Get YouTube Suggestions Results

Source: https://tools.pixelplus.ru/api/doc/podskazkiyoutube

After creating a task, use this to retrieve the parsed YouTube suggestions. Send a GET request with your API key and the report_id obtained from the task creation.

```http
GET: https://tools.pixelplus.ru/api/podskazkiyoutube?key=API_KEY&report_id=REPORT_ID
```

--------------------------------

### Retrieve Grouping Results (GET Request)

Source: https://tools.pixelplus.ru/api/doc/gruppirovka

After creating a grouping task, use this GET request format to retrieve the results using the provided report ID and your API key.

```http
$url = 'http://tools.pixelplus.ru/api/gruppirovka?key=q1i84o90a1s2d3fg5g6hj7';
```

--------------------------------

### Analiztopv2 API Error - Unknown Method

Source: https://tools.pixelplus.ru/api/doc/analiztopv2

This JSON indicates an error because an unknown API method name was specified.

```json
{"error":"unknown method","code":-3}
```