Search File Ai

GET

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

GET

/api/v1/firms/:firm_slug/ai/search

curl -G https://prod-whizboard-be-680473615767.asia-southeast1.run.app/api/v1/firms/firm_slug/ai/search \
     -H "Authorization: <apiKey>" \
     -d q=q

{
  "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"
}

Authentication

Authorizationstring

API Key authentication via header

Path parameters

firm_slugstringRequired3-64 characters

Query parameters

qstringRequired1-200 characters

categorylist of stringsOptionalDefaults to []

Filter by AI category. Repeat category for multiple values.

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-50Defaults to 10

Response

Successful Response

dataobject

statusstringOptionalDefaults to success

Errors

422

Unprocessable Entity Error