Overview
The node integrates with Eddie.surf, a web crawling and AI-powered smart search service. Specifically, the "Get Status" operation allows users to check the current status of a previously initiated crawl or smart search job by providing the job ID. This is useful for monitoring progress, verifying completion, or troubleshooting jobs.
Practical examples:
- After submitting a batch crawl job, use this node to poll the job status until it completes.
- Check the status of a smart search query to know when results are ready for retrieval.
- Optionally, check the status of an individual site within a crawl job to get granular progress updates.
Properties
| Name | Meaning |
|---|---|
| Job Type | Type of job to check status for. Options: "Crawl Job" (crawl or batch crawl job), "Smart Search Job" |
| Job ID | The unique identifier of the job whose status you want to check. |
| Site ID | Optional. When checking a crawl job, specify a particular site ID within that job to get its status. |
Output
The output JSON contains the status information returned from the Eddie.surf API for the specified job or site. The exact structure depends on the job type and server response but generally includes fields indicating progress, completion state, errors if any, and possibly detailed site-level statuses.
No binary data output is produced by this operation.
Dependencies
- Requires an API key credential for authenticating requests to the Eddie.surf API.
- The node uses HTTP GET requests to endpoints like
/crawl/{jobId},/crawl/{jobId}/{siteId}, or/smart-search/{jobId}. - Proper configuration of the API authentication credential in n8n is necessary.
Troubleshooting
- Missing Job ID: The node throws an error if the Job ID parameter is empty or missing. Ensure you provide a valid job ID string.
- Invalid Job Type: Only "crawl" and "smart-search" job types are supported. Using other values will cause an error.
- Site ID Usage: The Site ID parameter is only applicable when the Job Type is "crawl". Providing it for a smart search job has no effect.
- API Errors: Network issues, invalid credentials, or non-existent job IDs may result in API errors. Verify your API key and job identifiers.
- Empty or Malformed Responses: If the API returns unexpected data, check the job ID correctness and whether the job is still active.
Links and References
- Eddie.surf Official Website
- Eddie.surf API Documentation (hypothetical link for reference)