Overview
This node integrates with the Vast AI platform API, allowing users to perform various operations related to account management, billing, instances, search, templates, and volumes. Specifically, the "Search" resource with the "Search" operation enables querying Vast AI's marketplace or data sets such as offers, benchmarks, and templates.
Common scenarios include:
- Searching for available machine offers that match specific criteria.
- Retrieving benchmark data to compare machine performance.
- Finding templates for instance configurations.
Practical example:
- A user wants to find the best available GPU offers on Vast AI by specifying filters like GPU type, price range, or location. They use this node to send a search query and receive matching offers in JSON format.
Properties
| Name | Meaning |
|---|---|
| API Group Name or ID | Select the specific API endpoint group or action to call within the Search resource. Options include: search_benchmarks_get, search_offers_put, search_templates_get. You can choose from the list or specify an ID via expression. |
| Body | The request body parameters sent with the API call (used mainly for non-GET requests). It is a collection of key-value pairs where each key corresponds to a parameter name or ID, and the value is the parameter's value. For GET methods, this can be left blank or used to specify query parameters. |
Output
The node outputs an array of JSON objects corresponding to the API response from Vast AI. Each item contains the raw JSON data returned by the API for the requested search operation.
- For example, when searching offers, the output JSON will contain details about available machine offers matching the search criteria.
- When searching benchmarks or templates, the output JSON will contain relevant data sets accordingly.
The node does not output binary data.
Dependencies
- Requires an API key credential for Vast AI to authenticate requests.
- The node makes HTTP requests to the Vast AI API endpoint at
https://console.vast.ai/api/v0. - No additional external dependencies are required beyond standard n8n HTTP request capabilities.
Troubleshooting
- Missing Required Path Parameter: Some API calls require mandatory path parameters (e.g.,
idorinstance_id). If these are missing, the node throws an error indicating which parameter is missing. Ensure all required parameters are provided. - Invalid API Group or Operation: Selecting an unsupported API group or operation may result in no data or errors. Verify the selected API group matches the intended operation.
- Authentication Errors: If the API key is invalid or missing, authentication will fail. Confirm the API key credential is correctly configured.
- Empty or Incorrect Request Body: For PUT or POST requests, ensure the body parameters are correctly set; otherwise, the API may reject the request.
- Continue On Fail Behavior: If enabled, the node will continue processing subsequent items even if one fails, returning error details alongside input data.
Links and References
- Vast AI API Documentation: https://vast.ai/docs/api
- n8n Expressions Documentation: https://docs.n8n.io/code/expressions/
- Vast AI Platform: https://vast.ai/