> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.whizcozy.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.whizcozy.com/_mcp/server.

# Search File Ai

GET https://prod-whizboard-be-680473615767.asia-southeast1.run.app/api/v1/firms/{firm_slug}/ai/search

Reference: https://docs.whizcozy.com/api-reference/whiz-board-api/file-ai/search-file-ai-api-v-1-firms-firm-slug-ai-search-get

## Authentication

- `Authorization` header (required) — API Key authentication via header

## Request

### Path parameters

- `firm_slug` (string, required)

### Query parameters

- `q` (string, required)
- `category` (list of string, optional, default: []) — Filter by AI category. Repeat category for multiple values.
- `page` (integer, optional, default: 1)
- `page_size` (integer, optional, default: 10)

## Response

### 200

Successful Response

- `data` (FileAISearchResponse, required)
- `status` (string, optional, default: success)

## Errors

### 422 Unprocessable Entity Error

Validation Error

- `detail` (list of ValidationError, optional)

## Types

### FileAISearchResponse

- `items` (list of FileAISearchItem, required)
- `page` (integer, required)
- `page_size` (integer, required)
- `total` (integer, required)
- `total_pages` (integer, required)

### ValidationError

- `loc` (list of ValidationErrorLocItems, required)
- `msg` (string, required)
- `type` (string, required)
- `input` (any, optional)
- `ctx` (ValidationErrorCtx, optional)

### FileAISearchItem

- `file_id` (integer, required)
- `filename` (string, required)
- `score` (double, required)
- `matched_chunks` (list of FileAIChunkSearchHit, required)
- `mime_type` (string, optional, nullable)
- `owner_id` (integer, optional, nullable)
- `categories` (list of FileAICategoryResponse, optional)

### ValidationErrorLocItems

### ValidationErrorCtx

### FileAIChunkSearchHit

- `chunk_id` (integer, required)
- `chunk_index` (integer, required)
- `snippet` (string, required)
- `page_start` (integer, optional, nullable)
- `page_end` (integer, optional, nullable)

### FileAICategoryResponse

- `category` (string, required)
- `confidence` (integer, optional, nullable)
- `source` (string, optional, nullable)
- `reason` (string, optional, nullable)

## Examples

**Response**

```json
{
  "data": {
    "items": [
      {
        "file_id": 1,
        "filename": "string",
        "score": 1.1,
        "matched_chunks": [
          {
            "chunk_id": 1,
            "chunk_index": 1,
            "snippet": "string",
            "page_start": 1,
            "page_end": 1
          }
        ],
        "mime_type": "string",
        "owner_id": 1,
        "categories": [
          {
            "category": "string",
            "confidence": 1,
            "source": "string",
            "reason": "string"
          }
        ]
      }
    ],
    "page": 1,
    "page_size": 1,
    "total": 1,
    "total_pages": 1
  },
  "status": "success"
}
```

**SDK Code**

```python
import requests

url = "https://prod-whizboard-be-680473615767.asia-southeast1.run.app/api/v1/firms/firm_slug/ai/search"

querystring = {"q":"q"}

headers = {"Authorization": "<apiKey>"}

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

print(response.json())
```

```javascript
const url = 'https://prod-whizboard-be-680473615767.asia-southeast1.run.app/api/v1/firms/firm_slug/ai/search?q=q';
const options = {method: 'GET', headers: {Authorization: '<apiKey>'}};

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://prod-whizboard-be-680473615767.asia-southeast1.run.app/api/v1/firms/firm_slug/ai/search?q=q"

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

	req.Header.Add("Authorization", "<apiKey>")

	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://prod-whizboard-be-680473615767.asia-southeast1.run.app/api/v1/firms/firm_slug/ai/search?q=q")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<apiKey>'

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://prod-whizboard-be-680473615767.asia-southeast1.run.app/api/v1/firms/firm_slug/ai/search?q=q")
  .header("Authorization", "<apiKey>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://prod-whizboard-be-680473615767.asia-southeast1.run.app/api/v1/firms/firm_slug/ai/search?q=q', [
  'headers' => [
    'Authorization' => '<apiKey>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://prod-whizboard-be-680473615767.asia-southeast1.run.app/api/v1/firms/firm_slug/ai/search?q=q");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://prod-whizboard-be-680473615767.asia-southeast1.run.app/api/v1/firms/firm_slug/ai/search?q=q")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

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()
```