File Search API - Onboarding Buddy

The Onboarding Buddy File Search API enables developers to perform AI-driven semantic searches for documents, images, and videos. Leveraging Retrieval-Augmented Generation (RAG), this API enhances onboarding, compliance, and data management workflows by quickly locating relevant files.

Sign Up for File Search API

Why Use the Onboarding Buddy File Search API?

Search files intelligently to streamline onboarding, ensure compliance, and optimize data workflows. The Onboarding Buddy API uses AI-powered semantic search and RAG to find files based on content, context, and metadata, making it ideal for KYC, user verification, and content management applications.

Key Features

• Semantic Search: Find files using natural language queries, powered by AI-driven understanding.
• Advanced Filtering: Narrow search results by file type, date, or metadata for precise results.
• RAG Integration: Enhance search accuracy with Retrieval-Augmented Generation for context-aware results.
• Secure Access: Use App Key, API Key, and API Secret for authenticated requests.
• Scalable Performance: Handle large file repositories efficiently with optimized search endpoints.

Relevant Endpoints

Endpoint	Method	Purpose
POST /file-service/search	POST	Performs a semantic search for files based on a query and returns matching file metadata.
POST /file-service/search/advanced	POST	Performs an advanced semantic search with filters (e.g., file type, date) and returns matching file metadata.
GET /file-service/search/{searchId}	GET	Retrieves the results of a previous semantic search using the search ID.

Code Samples

Perform a Semantic File Search

Use the POST /file-service/search endpoint to perform a semantic search for files. Include your API credentials in the headers for secure access.

curl -X POST https://api.onboardingbuddy.co/file-service/search \
-H "ob-app-key: your-app-key" \
-H "ob-api-key: your-api-key" \
-H "ob-api-secret: your-api-secret" \
-H "Content-Type: application/json" \
-d '{"query": "KYC documents for user verification"}'
    

Example Response:

{
  "searchId": "search-12345",
  "results": [
    {
      "fileId": "file-12346",
      "fileName": "user_id_document.pdf",
      "fileType": "document",
      "metadata": {
        "classification": "KYC document",
        "uploadedAt": "2025-09-09T17:56:00Z",
        "storagePath": "gs://onboarding-buddy-files/file-12346"
      },
      "relevanceScore": 0.95
    },
    {
      "fileId": "file-12347",
      "fileName": "verification_form.pdf",
      "fileType": "document",
      "metadata": {
        "classification": "KYC document",
        "uploadedAt": "2025-09-10T10:30:00Z",
        "storagePath": "gs://onboarding-buddy-files/file-12347"
      },
      "relevanceScore": 0.90
    }
  ]
}
    

Perform an Advanced Semantic File Search

Use the POST /file-service/search/advanced endpoint to perform a semantic search with filters (e.g., file type, date).

curl -X POST https://api.onboardingbuddy.co/file-service/search/advanced \
-H "ob-app-key: your-app-key" \
-H "ob-api-key: your-api-key" \
-H "ob-api-secret: your-api-secret" \
-H "Content-Type: application/json" \
-d '{"query": "KYC documents", "filters": {"fileType": "document", "uploadedAfter": "2025-09-01"}}'
    

Example Response:

{
  "searchId": "search-12346",
  "results": [
    {
      "fileId": "file-12346",
      "fileName": "user_id_document.pdf",
      "fileType": "document",
      "metadata": {
        "classification": "KYC document",
        "uploadedAt": "2025-09-09T17:56:00Z",
        "storagePath": "gs://onboarding-buddy-files/file-12346"
      },
      "relevanceScore": 0.95
    }
  ]
}
    

Retrieve Search Results

Retrieve the results of a previous semantic search using the GET /file-service/search/{searchId} endpoint.

curl -X GET https://api.onboardingbuddy.co/file-service/search/search-12346 \
-H "ob-app-key: your-app-key" \
-H "ob-api-key: your-api-key" \
-H "ob-api-secret: your-api-secret"
    

Example Response:

{
  "searchId": "search-12346",
  "results": [
    {
      "fileId": "file-12346",
      "fileName": "user_id_document.pdf",
      "fileType": "document",
      "metadata": {
        "classification": "KYC document",
        "uploadedAt": "2025-09-09T17:56:00Z",
        "storagePath": "gs://onboarding-buddy-files/file-12346"
      },
      "relevanceScore": 0.95
    }
  ]
}
    

Applications of File Search

The Onboarding Buddy File Search API is ideal for:

• User Onboarding: Quickly locate user-uploaded documents for verification processes.
• KYC Compliance: Search compliance documents using semantic queries for regulatory workflows.
• Content Management: Find and organize user-generated content like images and videos.
• Data Analysis: Use RAG-powered searches to extract insights from large file repositories.

Next Steps

Get started with the Onboarding Buddy File Search API today. Sign up to obtain your API credentials, explore the full API documentation, or discover other use cases like file upload or email validation. For technical details, view all API endpoints.

Start Searching Files Now