Skip to content
Raindrop Developer Hub

Search

POST
/v1/search

Primary search endpoint that provides advanced search capabilities across all document types stored in Smart Buckets. Supports recursive object search within objects, enabling nested content search like embedded images, text content, and personally identifiable information (PII).

The system supports complex queries like:

  • ‘Show me documents containing credit card numbers or social security numbers’
  • ‘Find images of landscapes taken during sunset’
  • ‘Get documents mentioning revenue forecasts from Q4 2023’
  • ‘Find me all PDF documents that contain pictures of a cat’
  • ‘Find me all audio files that contain infomration about the weather in SF in 2024’

Key capabilities:

  • Natural language query understanding
  • Content-based search across text, images, and audio
  • Automatic PII detection
  • Multi-modal search (text, images, audio)

Authorizations

Request Body required

object
input
required

Natural language search query that can include complex criteria

string
request_id
required

Client-provided search session identifier. Required for pagination and result tracking. We recommend using a UUID or ULID for this value.

string
bucket_ids

Optional list of specific bucket IDs to search in. If not provided, searches the latest version of all buckets

Array<string>

Responses

200

Initial set of 15 search results with pagination information

object
results
required

Matched results with metadata

Array<object>
object
chunk_signature
required

Unique identifier for this text segment

string
/^chunk_[a-zA-Z0-9]+$/ 
chunk_123abc
text

The actual content of the result

string
This is a sample text chunk
source

Source document information in JSON format

string
{"bucket": "my-bucket", "path": "doc.pdf", "type": "application/pdf"}
payload_signature

Parent document identifier

string
/^doc_[a-zA-Z0-9]+$/ 
doc_456def
score

Relevance score (0.0 to 1.0)

number format: double
<= 1 
0.95
type

Content MIME type

string
Allowed values: text/plain application/pdf image/jpeg image/png 
text/plain
pagination
required
object
total
required

Total number of available results

integer
100
page
required

Current page number (1-based)

integer
>= 1 
1
page_size
required

Results per page

integer
>= 1 <= 100 
10
total_pages
required

Total available pages

integer
10
has_more
required

Indicates more results available

boolean
true

400

Invalid request parameters

object
code
required

Error code

string
Allowed values: INVALID_ARGUMENT UNAUTHENTICATED PERMISSION_DENIED NOT_FOUND INTERNAL 
INVALID_ARGUMENT
message
required

Error message

string
Missing required parameter: input