Skip to main content
POST
/
vault
/
{id}
/
search
Search vault documents
curl --request POST \
  --url https://api.case.dev/vault/{id}/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "method": "hybrid",
  "topK": 10,
  "filters": {
    "object_id": "<string>"
  }
}
'
{
  "method": "<string>",
  "query": "<string>",
  "response": "<string>",
  "sources": [
    {
      "id": "<string>",
      "filename": "<string>",
      "pageCount": 123,
      "textLength": 123,
      "chunkCount": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "ingestionCompletedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "chunks": [
    {
      "text": "<string>",
      "object_id": "<string>",
      "chunk_index": 123,
      "page_start": 123,
      "page_end": 123,
      "word_start_index": 123,
      "word_end_index": 123,
      "distance": 123,
      "score": 123,
      "source": "<string>"
    }
  ],
  "vault_id": "<string>"
}

Authorizations

Authorization
string
header
required

API key starting with sk_case_

Path Parameters

id
string
required

Unique identifier of the vault to search

Body

application/json
query
string
required

Search query or question to find relevant documents

method
enum<string>
default:hybrid

Search method: 'global' for comprehensive questions, 'entity' for specific entities, 'fast' for quick similarity search, 'hybrid' for combined approach

Available options:
vector,
graph,
hybrid,
global,
local,
fast,
entity
topK
integer
default:10

Maximum number of results to return

Required range: 1 <= x <= 100
filters
object

Filters to narrow search results to specific documents

Response

Search results with relevant documents and contextual answers

method
string

Search method used

query
string

Original search query

response
string

AI-generated answer based on search results (for global/entity methods)

sources
object[]
chunks
object[]

Relevant text chunks with similarity scores and page locations

vault_id
string

ID of the searched vault