zeelin-search_skill

Overview

This skill helps you query data using the Zeelin Search natural-language API and presents results in a human-friendly format. It first checks that Zeelin_Api_Key is configured, guides you through configuration if missing, then converts your natural-language request to JSON, calls the Zeelin Search API, prints request parameters, and always returns a clear result or error message. Results are saved as JSON in your user directory with a timestamped filename.

How this skill works

On activation it reads the dynamic configuration file (templates/config.json in the skill install path) and verifies Zeelin_Api_Key is present. If the key is missing it gives step-by-step setup instructions, including visiting the website, obtaining a key, and an example config snippet showing where to place Zeelin_Api_Key. It then reads references/nl2json.md to convert your natural language into the JSON payload (question_name), reads references/zenlin_search_api.md, announces that it will call the API, generates timestamp and HMAC-SHA256 sign using Zeelin_Api_Key, prints request parameters, sends a POST with Content-Type: application/json; charset=utf-8 and headers app-key, sign, timestamp, and finally displays results and writes the full API response to a timestamped JSON file in the user directory.

When to use it

• You want natural-language searching across indexed data via Zeelin Search.
• You need a clear, human-readable presentation of search results with metadata.
• You want the skill to validate that Zeelin_Api_Key is configured before calling the API.
• You want the raw API response saved to a JSON file for later inspection.
• You need consistent error handling and guidance if the API call fails.

Best practices

• Ensure templates/config.json in the skill install path contains Zeelin_Api_Key before requesting searches.
• Follow the provided steps to obtain and paste the key—examples and the exact config path are shown when missing.
• Keep user input concise so nl2json conversion produces an accurate question_name JSON.
• Review printed request parameters before proceeding if sensitive values are shown.
• Check the saved JSON file in your user directory for full API details and audit trail.

Example use cases

• "Use Zeelin Search to find mentions of product X in social media in the last 7 days."
• Convert a complex natural-language query into question_name JSON and retrieve ranked results.
• Run a diagnostic search to verify authentication and inspect headers/signature generation.
• Save API responses for offline analysis and reporting; filenames follow zeelin_search_results_YYYYMMDD_HHMMSS.json pattern.