Skip to main content

AvesAPI Integration with SmythOS

Need real-time search data for your workflows? Connect AvesAPI to SmythOS and let your agents fetch live Google SERP data, bypassing proxies and CAPTCHAs automatically.

TL;DR

Securely link your AvesAPI account to SmythOS using an API key. Then, use the Google Web Search component to empower your agents to retrieve live search results for any query, domain, and location.

List of AvesAPI Components

Quickly compare AvesAPI components by what they do and their key I/O.

ComponentActionWhat it DoesInputsKey OutputsUse Case
Google Web SearchReadFetches real-time Google SERP data for a query.required query
optional google_domain, num
organic_resultsTrack keyword rankings or research topics.
INFO
Why Integrate AvesAPI with Your Agent?

AvesAPI simplifies the complex process of scraping Google Search results. By integrating it with SmythOS, you can build powerful, data-driven agents that rely on the most current information from the web.

  • Automated SEO Tracking: Schedule agents to run daily or weekly queries to track your website's ranking for key terms against competitors.
  • Market Research: Automatically gather search results for product names, brands, or industry terms to analyze market trends, sentiment, and top players.
  • Content & AI Workflows: Use an agent to perform a Google search on a topic, feed the results into an AI model for summarization, and generate a brief—all in one seamless flow.
  • Data Collection: Effortlessly collect URLs, snippets, and other data from search results to build datasets for analysis or lead generation without worrying about getting blocked.

Prerequisites

Before you begin, please ensure you have the following:

  • An active SmythOS account. (Sign up here).
  • An AvesAPI account.
  • Your AvesAPI API Key.

Getting Started With AvesAPI

The connection between SmythOS and AvesAPI is configured using a secure API key.

Step 1: Get Your AvesAPI API Key

  1. Log in to your AvesAPI account.
  2. Navigate to your profile page.
  3. Your API Key is displayed on this page. Copy it.

Step 2: Store Your API Key in SmythOS Vault

Your AvesAPI Key is a sensitive credential. Use the SmythOS Vault to store it securely.

  1. In your SmythOS dashboard, navigate to the Vault.
  2. Create a new secret and paste your AvesAPI API Key as the value. Give it a memorable name, like avesapi_api_key.
  3. For more details, see the Vault Documentation.

Step 3: Configure the AvesAPI Component

  1. In your SmythOS agent graph, drag and drop the Google Web Search component.
  2. Click the component to open its Settings panel.
  3. In the API Key field, select the secret you saved in the Vault (e.g., avesapi_api_key).
  4. Your connection is now configured for that component.
Heads-up
You must add the API Key from the Vault to each AvesAPI component you use. This provides granular control and ensures all connections are secure.

Which AvesAPI Component Should I Use?

If you need to…TargetUse this ComponentWhy this one?
Get Google search results for a keywordA search queryGoogle Web SearchThe core component for all real-time SERP data retrieval.

Component Details

This section provides detailed information for the AvesAPI component.

Retrieves real-time Google Search Engine Results Page (SERP) data for a given query, handling all proxies and CAPTCHAs automatically.

INFO
This component requires an API Key for authentication, as detailed in the Getting Started section.

Inputs

FieldRequiredNotes
queryrequiredThe keyword or phrase to search for on Google.
google_country_codeoptionalTwo-letter country code for localized results (e.g., de for Germany). Default: us.
google_ui_languageoptionalTwo-letter language code for the UI (e.g., es for Spanish). Default: en.
google_domainoptionalThe Google domain to use (e.g., google.co.uk). Default: google.com.
numoptionalThe number of search results to return (e.g., 100). Default: 10.

Outputs

FieldDescription
organic_resultsAn array of objects, each representing a standard, non-paid search result.
responseThe raw JSON response from the AvesAPI, including all SERP features found.
headersHTTP headers from the API response.
Use Case

Create a rank-tracking agent. Schedule it to run daily, search for your target keyword, loop through the organic_results, and find your website's position. Log the position and date to a Google Sheet to monitor performance over time.

{
"component": "avesapi.googleWebSearch",
"query": "SmythOS no-code automation",
"google_country_code": "us",
"num": 20
}
API Usage

Each query consumes credits from your AvesAPI account. Higher num values or more frequent queries will increase consumption.

Best Practices & Advanced Tips

  • Secure Your API Key: Your AvesAPI key is a credential. Always use the SmythOS Vault to store it securely.
  • Refine Your Queries: Use specific country and language codes to get the most accurate SERP data for your target audience.
  • Parse the response Output: The organic_results output is convenient, but the full response object contains a wealth of extra information, such as "People Also Ask," "Related Searches," and "Knowledge Graph" data that can be used for more advanced analysis.
  • Handle Errors: While AvesAPI handles common scraping issues, network errors can still occur. Build error-handling logic into your agent to manage failed requests gracefully.

Troubleshooting Common Issues

  • Error: 401 Unauthorized

    • Cause: The API key is invalid, missing, or has been disabled.
    • Solution: Verify that the API key in your SmythOS Vault is correct and matches the one in your AvesAPI profile. Ensure your AvesAPI account is active.
  • Error: 402 Payment Required

    • Cause: You have run out of credits in your AvesAPI account.
    • Solution: Log in to your AvesAPI dashboard to check your credit balance and top up if necessary.
  • Empty organic_results Array

    • Cause: The query may have genuinely returned no organic results for the specified parameters, or the query itself was blocked for other reasons.
    • Solution: Test the query in your browser to ensure it's valid. Check the full response object for any error messages or details from AvesAPI.

What's Next?

You're now ready to build powerful, data-driven workflows with the SmythOS AvesAPI Integration!

Consider these ideas:

  • Build an Agent That...

    • Monitors Google Search for mentions of your brand, extracts the URL and snippet, and sends a daily summary to a Slack channel.
    • Performs a search for a list of competitor domains and analyzes their top-ranking pages to identify content gaps.
    • Gathers the top 10 results for a "how-to" query and feeds them to an AI component to generate a comprehensive, summarized answer.
  • Explore Other Integrations: Combine AvesAPI with other SmythOS tools. Use the Google Sheets Integration to log ranking data, or connect to the Ahrefs Integration to further analyze the SEO metrics of the URLs you discover.