Needle AI Platform Integration

A powerful Apify Actor that integrates with the Needle AI platform to manage documents and perform semantic searches using AI capabilities. This Actor allows you to interact with your Needle collections programmatically through the Apify platform.

Overview

This Actor provides seamless integration with the Needle AI platform, enabling you to:

• List Collections: Retrieve all collections from your Needle account
• Search Documents: Perform semantic searches within specific collections
• Create Collections: Set up new document collections
• Add Documents: Add documents to existing collections via URLs

Features

• 🔍 Semantic Search: Leverage AI to find relevant documents using natural language queries
• 📚 Document Management: Organize and manage your document collections
• 🤖 AI-Powered: Uses advanced language models for intelligent document retrieval
• 🔗 Easy Integration: Works seamlessly with the Apify platform and Needle ecosystem
• ⚡ Scalable: Built on Apify's cloud infrastructure for reliable performance

How it works

1. Authentication: Get your API key from Needle Settings
2. Action Selection: Choose the operation you want to perform (list, search, create, add)
3. Parameter Configuration: Set the required parameters for your chosen action
4. Execution: The Actor communicates with the Needle AI platform and returns results
5. Results: Get structured data back with your search results or operation status

Quick Start

1. Get your Needle API key: Visit Needle Settings to generate your API key
2. Run the Actor: Choose from the available actions (list collections, search, create, add documents)
3. View results: Get structured data back with your collections, search results, or operation status

Supported Operations

List Collections

Retrieve all collections in your Needle account:

{
  "action": "list_collections",
  "needle_api_key": "your-api-key"
}

Search Collection

Perform semantic search within a specific collection:

{
  "action": "search_collection",
  "needle_api_key": "your-api-key",
  "collection_id": "collection-id",
  "query": "information about AI and machine learning"
}

Create Collection

Create a new collection for organizing documents:

{
  "action": "create_collection",
  "needle_api_key": "your-api-key",
  "collection_name": "My Research Collection"
}

Add Documents

Add documents to an existing collection:

{
  "action": "add_documents",
  "needle_api_key": "your-api-key",
  "collection_id": "collection-id",
  "document_urls": "[\"https://example.com/doc1.pdf\", \"https://example.com/doc2.pdf\"]"
}

Use Cases

• 📚 Knowledge Management: Build searchable knowledge bases from web content
• 🔍 Research Automation: Automatically collect and search through research materials
• 📊 Competitive Intelligence: Monitor competitor content and extract insights
• 📝 Content Analysis: Analyze large volumes of documents for key information
• 🤖 RAG Pipelines: Build Retrieval-Augmented Generation workflows

Output

The Actor returns structured data in JSON format containing:

• Collection information and metadata
• Search results with relevance scores
• Operation status and confirmation messages
• Error details if operations fail

Configuration

Required Fields

• needle_api_key: Your Needle API key (can also be set via NEEDLE_API_KEY environment variable)
• action: The operation to perform

Optional Fields (depending on action)

• collection_id: Required for search and add operations
• query: Search query text (for search operations)
• collection_name: Name for new collections
• document_urls: JSON array of document URLs to add

Support

• Documentation: Needle API Documentation
• Community: Join our Discord community for support and discussions
• Issues: Report issues on GitHub

About Needle

Needle AI is a platform that simplifies building RAG (Retrieval-Augmented Generation) pipelines. It provides semantic search capabilities and document management tools to help you build intelligent applications with AI.

Visit needle-ai.com to learn more.