---
metadata:
  - name: generator
    content: Diplodoc Platform v5.63.4
alternate:
  - https://yandex.com.tr/support/wiki/en/api-ref/search/search__search.md
  - href: https://yandex.com.tr/support/wiki/en/api-ref/search/search__search.md
    type: text/markdown
    title: Markdown version
  - href: https://yandex.com.tr/support/wiki/en/llms.txt?revision=r21710248
    rel: describedby
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com.tr/support/wiki/en/llms.txt?revision=r21710248

<div class="openapi">

# Search

<!-- markdownlint-disable-file -->

Search wiki page text.

## Request

<div class="openapi__requests">

<div class="openapi__request__wrapper" style="--method: var(--dc-openapi-methods-post);margin-bottom: 12px">

<div class="openapi__request">

POST {.openapi__method}
```text translate=no
https://api.wiki.yandex.net/v1/search
```

</div>

</div>

</div>

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "query": "example",
  "filters": {
    "type": "file",
    "authors": [
      {
        "uid": "example",
        "cloud_uid": "example"
      }
    ],
    "cluster": "example",
    "created_at": {
      "from": "2025-01-01T00:00:00Z",
      "to": "2025-01-01T00:00:00Z"
    },
    "modified_at": null,
    "show_obsolete": false
  },
  "cursor": 1,
  "limit": 10,
  "order_by": "relevancy",
  "highlight": false
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_query_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_cursor_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Cursor for retrieving a page of results

_Default:_{.json-schema-reset .json-schema-value} `1`

_Min value:_{.json-schema-reset .json-schema-assertion} `1`

_Max value:_{.json-schema-reset .json-schema-assertion} `500`
{.table-cell}
||
||

_filters_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [SearchFilters](#entity-SearchFilters)

Search query conditions.

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "type": "file",
  "authors": [
    {
      "uid": "example",
      "cloud_uid": "example"
    }
  ],
  "cluster": "example",
  "created_at": {
    "from": "2025-01-01T00:00:00Z",
    "to": "2025-01-01T00:00:00Z"
  },
  "modified_at": null,
  "show_obsolete": false
}
```

{% endcut %}
{.table-cell}
||
||

_highlight_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Highlight text fragments that match the query

_Default:_{.json-schema-reset .json-schema-value} `false`
{.table-cell}
||
||

_limit_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Number of results per page of results

_Default:_{.json-schema-reset .json-schema-value} `10`

_Min value:_{.json-schema-reset .json-schema-assertion} `1`

_Max value:_{.json-schema-reset .json-schema-assertion} `50`
{.table-cell}
||
||

_order_by_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **OrderType**

  **Type**: [OrderType](#entity-OrderType)

  Sort order for the results.

  _Enum:_{.json-schema-reset .json-schema-value} `relevancy`, `creation_date`, `modified_date`

{% endcut %}

_Default:_{.json-schema-reset .json-schema-value} `relevancy`
{.table-cell}
||
|#{.json-schema-properties}

</div>

<div class="openapi-entity">

### SearchDocumentType {#entity-SearchDocumentType}

Resource type for search.

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `file`, `page`

</div>

<div class="openapi-entity">

### UserIdentity {#entity-UserIdentity}

User identifier

#|
|| **Name** | **Description** ||
||

_cloud_uid_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

User identifier in the cloud

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_uid_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

User identifier

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "uid": "example",
  "cloud_uid": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### DateInterval {#entity-DateInterval}

#|
|| **Name** | **Description** ||
||

_from_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string&lt;date-time&gt;

_Example:_{.json-schema-reset .json-schema-example} `2025-01-01T00:00:00Z`
{.table-cell}
||
||

_to_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string&lt;date-time&gt;

_Example:_{.json-schema-reset .json-schema-example} `2025-01-01T00:00:00Z`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "from": "2025-01-01T00:00:00Z",
  "to": "2025-01-01T00:00:00Z"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### SearchFilters {#entity-SearchFilters}

Search query conditions.

#|
|| **Name** | **Description** ||
||

_authors_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [UserIdentity](#entity-UserIdentity)[]

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "uid": "example",
    "cloud_uid": "example"
  }
]
```

{% endcut %}
{.table-cell}
||
||

_cluster_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Min length:_{.json-schema-reset .json-schema-assertion} `1`

_Max length:_{.json-schema-reset .json-schema-assertion} `255`

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_created_at_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [DateInterval](#entity-DateInterval)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "from": "2025-01-01T00:00:00Z",
  "to": "2025-01-01T00:00:00Z"
}
```

{% endcut %}
{.table-cell}
||
||

_modified_at_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [DateInterval](#entity-DateInterval)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "from": "2025-01-01T00:00:00Z",
  "to": "2025-01-01T00:00:00Z"
}
```

{% endcut %}
{.table-cell}
||
||

_show_obsolete_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

_Default:_{.json-schema-reset .json-schema-value} `false`
{.table-cell}
||
||

_type_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [SearchDocumentType](#entity-SearchDocumentType)

Resource type for search.

_Enum:_{.json-schema-reset .json-schema-value} `file`, `page`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "type": "file",
  "authors": [
    {
      "uid": "example",
      "cloud_uid": "example"
    }
  ],
  "cluster": "example",
  "created_at": {
    "from": "2025-01-01T00:00:00Z",
    "to": "2025-01-01T00:00:00Z"
  },
  "modified_at": null,
  "show_obsolete": false
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrderType {#entity-OrderType}

Sort order for the results.

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `relevancy`, `creation_date`, `modified_date`

</div>

## Responses

<div class="openapi__response__code__200">

## 200 OK

OK

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "results": [
    {
      "url": "example",
      "slug": "example",
      "title": "example",
      "content": "example",
      "type": "file",
      "modified_at": "2025-01-01T00:00:00Z"
    }
  ],
  "next_cursor": "example",
  "prev_cursor": "example"
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_results_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [SearchQueryResponseResult](#entity-SearchQueryResponseResult)[]

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "url": "example",
    "slug": "example",
    "title": "example",
    "content": "example",
    "type": "file",
    "modified_at": "2025-01-01T00:00:00Z"
  }
]
```

{% endcut %}
{.table-cell}
||
||

_next_cursor_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_prev_cursor_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

</div>

<div class="openapi-entity">

### SearchQueryResponseResult {#entity-SearchQueryResponseResult}

#|
|| **Name** | **Description** ||
||

_content_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_modified_at_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string&lt;date-time&gt;

_Example:_{.json-schema-reset .json-schema-example} `2025-01-01T00:00:00Z`
{.table-cell}
||
||

_slug_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_title_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_type_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [SearchDocumentType](#entity-SearchDocumentType)

Resource type for search.

_Enum:_{.json-schema-reset .json-schema-value} `file`, `page`
{.table-cell}
||
||

_url_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "url": "example",
  "slug": "example",
  "title": "example",
  "content": "example",
  "type": "file",
  "modified_at": "2025-01-01T00:00:00Z"
}
```

{% endcut %}

</div>

</div>

</div>

[*Deprecated]: No longer supported, please use an alternative and newer version.