> This is a page from the ElevenLabs documentation. For a complete page index, fetch https://elevenlabs.io/docs/llms.txt. For the full documentation in a single file, fetch https://elevenlabs.io/docs/llms-full.txt.

# Przeszukaj zawartość bazy wiedzy

GET https://api.elevenlabs.io/v1/convai/knowledge-base/search

Przybliżone wyszukiwanie tekstowe w treści dokumentów bazy wiedzy

Reference: https://elevenlabs.io/docs/eleven-agents/api-reference/knowledge-base/search

## Servers

- `https://api.elevenlabs.io` (Production, default)
- `https://api.us.elevenlabs.io` (Production US)
- `https://api.eu.residency.elevenlabs.io` (Production EU)
- `https://api.in.residency.elevenlabs.io` (Production India)
- `https://api.sg.residency.elevenlabs.io` (Production Singapore)

## Request

### Query parameters

- `query` (string, required) — Tekst zapytania wyszukiwania
- `page_size` (integer, optional, default: 30) — Maksymalna liczba dokumentów do zwrócenia. Nie może przekraczać 100, domyślnie 30.
- `types` (enum, optional) — Jeśli podano, endpoint zwróci tylko dokumenty danych typów.
  - Allowed values: `file`, `url`, `text`, `folder`
- `cursor` (string, optional) — Służy do pobrania następnej strony. Kursor jest zwracany w odpowiedzi.

## Response

### 200

Pomyślna odpowiedź

- `results` (list of KnowledgeBaseContentSearchResult, required)
- `next_cursor` (string, optional)

## Errors

### 422 Knowledge Base Search Request Unprocessable Entity Error

Błąd walidacji

- `detail` (list of ValidationError, optional)

## Types

### KnowledgeBaseContentSearchResult

- `document` (KnowledgeBaseContentSearchResultDocument, required)
- `score` (double, required)
- `search_snippet` (list of SearchHighlightSegment, optional)

### ValidationError

- `loc` (list of ValidationErrorLocItem, required)
- `msg` (string, required)
- `type` (string, required)

### KnowledgeBaseContentSearchResultDocument

- `type`: `file`
  - `access_info` (ResourceAccessInfo, required)
  - `id` (string, required)
  - `metadata` (KnowledgeBaseDocumentMetadataResponseModel, required)
  - `name` (string, required)
  - `supported_usages` (list of enum, required)
    - Allowed values: `prompt`, `auto`
  - `dependent_agents` (list of GetKnowledgeBaseSummaryFileResponseModelDependentAgentsItem, required, deprecated) — To pole jest przestarzałe i zostanie usunięte w przyszłości. Zamiast tego użyj osobnego endpointu, aby pobrać zależnych agentów.
  - `auto_sync_info` (AutoSyncInfo, optional)
  - `external_sync_info` (ExternalFileSyncInfo, optional) — Śledzi link do oryginalnego pliku w zewnętrznym źródle.
  - `folder_parent_id` (string, optional) — ID folderu nadrzędnego albo null, jeśli dokument znajduje się w katalogu głównym.
  - `folder_path` (list of KnowledgeBaseFolderPathSegmentSummaryResponseModel, optional) — Segmenty ścieżki folderów prowadzące do tego elementu, od katalogu głównego do folderu nadrzędnego.
  - `is_frozen` (boolean, optional, default: false)
  - `refresh_status` (FileRefreshStatus, optional) — Stan trwającego/ostatniego odświeżania pliku KB synchronizowanego zewnętrznie.
- `type`: `folder`
  - `access_info` (ResourceAccessInfo, required)
  - `children_count` (integer, required)
  - `document_count` (integer, required) — Liczba dokumentów niebędących folderami w całym poddrzewie tego folderu (rekurencyjnie). Liczenie kończy się po 1000;
  - `id` (string, required)
  - `metadata` (KnowledgeBaseDocumentMetadataResponseModel, required)
  - `name` (string, required)
  - `supported_usages` (list of enum, required)
    - Allowed values: `prompt`, `auto`
  - `dependent_agents` (list of GetKnowledgeBaseSummaryFolderResponseModelDependentAgentsItem, required, deprecated) — To pole jest przestarzałe i zostanie usunięte w przyszłości. Zamiast tego użyj osobnego endpointu, aby pobrać zależnych agentów.
  - `auto_sync_info` (AutoSyncInfo, optional)
  - `external_sync_info` (ExternalFolderSyncInfo, optional) — Metadane folderu bazy wiedzy odzwierciedlającego zewnętrzny folder źródłowy.
  - `folder_parent_id` (string, optional) — ID folderu nadrzędnego albo null, jeśli dokument znajduje się w katalogu głównym.
  - `folder_path` (list of KnowledgeBaseFolderPathSegmentSummaryResponseModel, optional) — Segmenty ścieżki folderów prowadzące do tego elementu, od katalogu głównego do folderu nadrzędnego.
  - `is_frozen` (boolean, optional, default: false)
- `type`: `text`
  - `access_info` (ResourceAccessInfo, required)
  - `id` (string, required)
  - `metadata` (KnowledgeBaseDocumentMetadataResponseModel, required)
  - `name` (string, required)
  - `supported_usages` (list of enum, required)
    - Allowed values: `prompt`, `auto`
  - `dependent_agents` (list of GetKnowledgeBaseSummaryTextResponseModelDependentAgentsItem, required, deprecated) — To pole jest przestarzałe i zostanie usunięte w przyszłości. Zamiast tego użyj osobnego endpointu, aby pobrać zależnych agentów.
  - `folder_parent_id` (string, optional) — ID folderu nadrzędnego albo null, jeśli dokument znajduje się w katalogu głównym.
  - `folder_path` (list of KnowledgeBaseFolderPathSegmentSummaryResponseModel, optional) — Segmenty ścieżki folderów prowadzące do tego elementu, od katalogu głównego do folderu nadrzędnego.
- `type`: `url`
  - `access_info` (ResourceAccessInfo, required)
  - `id` (string, required)
  - `metadata` (KnowledgeBaseDocumentMetadataResponseModel, required)
  - `name` (string, required)
  - `supported_usages` (list of enum, required)
    - Allowed values: `prompt`, `auto`
  - `url` (string, required)
  - `dependent_agents` (list of GetKnowledgeBaseSummaryUrlResponseModelDependentAgentsItem, required, deprecated) — To pole jest przestarzałe i zostanie usunięte w przyszłości. Zamiast tego użyj osobnego endpointu, aby pobrać zależnych agentów.
  - `auto_sync_info` (AutoSyncInfo, optional)
  - `folder_parent_id` (string, optional) — ID folderu nadrzędnego albo null, jeśli dokument znajduje się w katalogu głównym.
  - `folder_path` (list of KnowledgeBaseFolderPathSegmentSummaryResponseModel, optional) — Segmenty ścieżki folderów prowadzące do tego elementu, od katalogu głównego do folderu nadrzędnego.

### SearchHighlightSegment

- `value` (string, required)
- `is_hit` (boolean, required)

### ValidationErrorLocItem

- string
- integer

### ResourceAccessInfo

- `is_creator` (boolean, required) — Czy użytkownik wysyłający żądanie jest twórcą agenta
- `creator_name` (string, required) — Nazwa twórcy agenta
- `creator_email` (string, required) — E-mail twórcy agenta
- `role` (enum, required) — Rola użytkownika wysyłającego żądanie
  - Allowed values: `admin`, `editor`, `commenter`, `viewer`
- `anonymous_access_level_override` (enum, optional) — Poziom dostępu dla anonimowych użytkowników. Jeśli None, zasób nie jest publicznie udostępniany.
  - Allowed values: `admin`, `editor`, `commenter`, `viewer`
- `access_source` (enum, optional) — Dlaczego użytkownik wysyłający żądanie ma dostęp do tego zasobu. 'creator' = wywołujący jest właścicielem. 'explicit' = wywołujący (lub jedna z jego grup workspace) jest wymieniony w role_to_group_ids poza ogólną grupą everyone dla workspace. 'workspace_default' = ogólna grupa everyone dla workspace jest wymieniona w role_to_group_ids (ten zasób widzi każdy nieanonimowy członek workspace, w tym administratorzy). 'workspace_admin' = wywołujący jest administratorem workspace, a uprawnienia administratora są *jedyną* ścieżką dostępu; zarezerwowane dla dokumentów, których nikt inny nie może zobaczyć. Pozwala interfejsowi wyjaśnić, dlaczego użytkownik omijający ograniczenia jako administrator widzi dokument, który nie został mu wyraźnie udostępniony.
  - Allowed values: `creator`, `explicit`, `workspace_admin`, `workspace_default`

### KnowledgeBaseDocumentMetadataResponseModel

- `created_at_unix_secs` (integer, required)
- `last_updated_at_unix_secs` (integer, required)
- `size_bytes` (integer, required)

### GetKnowledgeBaseSummaryFileResponseModelDependentAgentsItem

- `type`: `available`
  - `access_level` (enum, required)
    - Allowed values: `admin`, `editor`, `commenter`, `viewer`
  - `created_at_unix_secs` (integer, required)
  - `id` (string, required)
  - `name` (string, required)
  - `referenced_resource_ids` (list of string, optional) — Jeśli agent jest zależnością przechodnią, zawiera identyfikatory zasobów, od których agent zależy bezpośrednio.
- `type`: `unknown`
  - `id` (string, required)
  - `referenced_resource_ids` (list of string, optional) — Jeśli agent jest zależnością przechodnią, zawiera identyfikatory zasobów, od których agent zależy bezpośrednio.

### AutoSyncInfo

- `minimum_frequency_days` (integer, optional, default: 7) — Minimalna częstotliwość odświeżania dokumentu (w dniach). Rzeczywisty odstęp może być krótszy, ale nigdy dłuższy.
- `auto_remove` (boolean, optional, default: false) — Czy usunąć dokument, jeśli URL stanie się niedostępny
- `consec_failures` (integer, optional, default: 0) — Liczba kolejnych błędów synchronizacji
- `next_refresh_by` (integer, optional) — Znacznik czasu Unix następnej zaplanowanej synchronizacji lub None (w przypadku folderów)
- `auto_discover` (boolean, optional, default: false, deprecated) — Przestarzałe. To pole nie ma już żadnego efektu i zostanie usunięte w przyszłej wersji.

### ExternalFileSyncInfo

Śledzi link do oryginalnego pliku w zewnętrznym źródle.

- `type` ("google_drive", required) — Identyfikator dostawcy
- `source_entity_id` (string, required) — ID encji w systemie zewnętrznym
- `integration_connection_id` (string, required) — Identyfikator instancji połączenia integracji
- `source_parent_entity_id` (string, required) — ID folderu w systemie zewnętrznym, z którego zsynchronizowano ten plik
- `source_mime_type` (string, required) — Oryginalny typ MIME w systemie zewnętrznym
- `source_modified_time` (datetime, required) — Czas ostatniej modyfikacji w systemie zewnętrznym
- `root_folder_id` (string, optional) — Identyfikator folderu KB katalogu głównego synchronizacji, używany do wyszukiwania wszystkich elementów w drzewie synchronizacji

### KnowledgeBaseFolderPathSegmentSummaryResponseModel

- `id` (string, required)

### FileRefreshStatus

Stan trwającego/ostatniego odświeżania pliku KB synchronizowanego zewnętrznie.

- `status` (enum, optional, default: queued)
  - Allowed values: `queued`, `processing`, `succeeded`, `failed`, `skipped`, `cancelled`
- `enqueued_at` (integer, optional)
- `started_at` (integer, optional)
- `completed_at` (integer, optional)
- `last_synced_at` (integer, optional)
- `error_message` (string, optional)

### GetKnowledgeBaseSummaryFolderResponseModelDependentAgentsItem

- `type`: `available`
  - `access_level` (enum, required)
    - Allowed values: `admin`, `editor`, `commenter`, `viewer`
  - `created_at_unix_secs` (integer, required)
  - `id` (string, required)
  - `name` (string, required)
  - `referenced_resource_ids` (list of string, optional) — Jeśli agent jest zależnością przechodnią, zawiera identyfikatory zasobów, od których agent zależy bezpośrednio.
- `type`: `unknown`
  - `id` (string, required)
  - `referenced_resource_ids` (list of string, optional) — Jeśli agent jest zależnością przechodnią, zawiera identyfikatory zasobów, od których agent zależy bezpośrednio.

### ExternalFolderSyncInfo

Metadane folderu bazy wiedzy odzwierciedlającego zewnętrzny folder źródłowy.

- `type` ("google_drive", required) — Identyfikator dostawcy
- `source_entity_id` (string, required) — ID encji w systemie zewnętrznym
- `integration_connection_id` (string, required) — Identyfikator instancji połączenia integracji
- `root_folder_id` (string, optional) — Identyfikator folderu KB katalogu głównego synchronizacji. None oznacza, że ten folder jest katalogiem głównym.
- `sync_cursor` (string, optional) — Nieprzezroczysty kursor synchronizacji przyrostowej interpretowany przez dostawcę
- `last_sync_at` (integer, optional) — Znacznik czasu Unix ostatniej ukończonej synchronizacji

### GetKnowledgeBaseSummaryTextResponseModelDependentAgentsItem

- `type`: `available`
  - `access_level` (enum, required)
    - Allowed values: `admin`, `editor`, `commenter`, `viewer`
  - `created_at_unix_secs` (integer, required)
  - `id` (string, required)
  - `name` (string, required)
  - `referenced_resource_ids` (list of string, optional) — Jeśli agent jest zależnością przechodnią, zawiera identyfikatory zasobów, od których agent zależy bezpośrednio.
- `type`: `unknown`
  - `id` (string, required)
  - `referenced_resource_ids` (list of string, optional) — Jeśli agent jest zależnością przechodnią, zawiera identyfikatory zasobów, od których agent zależy bezpośrednio.

### GetKnowledgeBaseSummaryUrlResponseModelDependentAgentsItem

- `type`: `available`
  - `access_level` (enum, required)
    - Allowed values: `admin`, `editor`, `commenter`, `viewer`
  - `created_at_unix_secs` (integer, required)
  - `id` (string, required)
  - `name` (string, required)
  - `referenced_resource_ids` (list of string, optional) — Jeśli agent jest zależnością przechodnią, zawiera identyfikatory zasobów, od których agent zależy bezpośrednio.
- `type`: `unknown`
  - `id` (string, required)
  - `referenced_resource_ids` (list of string, optional) — Jeśli agent jest zależnością przechodnią, zawiera identyfikatory zasobów, od których agent zależy bezpośrednio.

## Examples

**Response**

```json
{
  "results": [
    {
      "document": {
        "type": "file",
        "access_info": {
          "is_creator": true,
          "creator_name": "John Doe",
          "creator_email": "john.doe@example.com",
          "role": "admin",
          "access_source": "creator"
        },
        "id": "id",
        "metadata": {
          "created_at_unix_secs": 1,
          "last_updated_at_unix_secs": 1,
          "size_bytes": 1
        },
        "name": "name",
        "supported_usages": [
          "prompt"
        ],
        "dependent_agents": [
          {
            "type": "available",
            "access_level": "admin",
            "created_at_unix_secs": 1,
            "id": "id",
            "name": "name"
          }
        ]
      },
      "score": 1.1,
      "search_snippet": [
        {
          "value": "value",
          "is_hit": true
        }
      ]
    }
  ],
  "next_cursor": "next_cursor"
}
```

**SDK Code**

```python
import requests

url = "https://api.elevenlabs.io/v1/convai/knowledge-base/search"

querystring = {"cursor":"cursor","page_size":"1","query":"query","types":"[\"file\"]"}

response = requests.get(url, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.elevenlabs.io/v1/convai/knowledge-base/search?cursor=cursor&page_size=1&query=query&types=%5B%22file%22%5D';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.elevenlabs.io/v1/convai/knowledge-base/search?cursor=cursor&page_size=1&query=query&types=%5B%22file%22%5D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.elevenlabs.io/v1/convai/knowledge-base/search?cursor=cursor&page_size=1&query=query&types=%5B%22file%22%5D")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.elevenlabs.io/v1/convai/knowledge-base/search?cursor=cursor&page_size=1&query=query&types=%5B%22file%22%5D")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.elevenlabs.io/v1/convai/knowledge-base/search?cursor=cursor&page_size=1&query=query&types=%5B%22file%22%5D');

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/convai/knowledge-base/search?cursor=cursor&page_size=1&query=query&types=%5B%22file%22%5D");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.elevenlabs.io/v1/convai/knowledge-base/search?cursor=cursor&page_size=1&query=query&types=%5B%22file%22%5D")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```