API Key Models Playground GitHub Get Support

AI Search Engine

Last updated 3 days ago

Was this helpful?

AI Search Engine

Overview

AI Web Search Engine is designed to retrieve real-time information from the internet. This solution processes user queries and return relevant data from various online sources, making them useful for tasks that require up-to-date knowledge beyond static datasets. It supports two usage options:

Using six specialized API endpoints, each designed to search for only one specific type of information. These endpoints return structured responses, making them more suitable for integration into specialized services (e.g., a weather widget). Here are the types of information you can retrieve this way:

See API references and examples on the subpages.

As a general chat completion solution (but searching on the internet): enter a query in the prompt and receive an internet-sourced answer, similar to asking a question on a search engine through a browser. See the API Schema below or check how this call is made in the Python example on the bottom of this page.

How to make a call

Check how this call is made in the examples below.

Note that queries can include advanced search syntax:

Search for an exact match: Enter a word or phrase using \" before and after it. For example, \"tallest building\".
Search for a specific site: Enter site: in front of a site or domain. For example, site:youtube.com cat videos.
Exclude words from your search: Enter - in front of a word that you want to leave out. For example, jaguar speed -car.

You can also personalize the AI Search Engine output by passing the ip parameter. See Example #2 below.

API Schema

Example #1

import requests
from openai import OpenAI

# Insert your AIML API Key instead of <YOUR_AIMLAPI_KEY>:
API_KEY = '<YOUR_AIMLAPI_KEY>'
API_URL = 'https://api.aimlapi.com'

def complete_chat():
    client = OpenAI(
        base_url=API_URL,
        api_key=API_KEY,
    )    

    response = client.chat.completions.create(
        model="bagoodex/bagoodex-search-v1",
        messages=[
            {
                "role": "user",
                
                # Enter your query here
                "content": 'how to make a slingshot',
            },
        ],
    )
    
    
    print(response.choices[0].message.content)


# Run the function
complete_chat()

// Insert your AIML API Key instead of <YOUR_AIMLAPI_KEY>:
const API_KEY = '<YOUR_AIMLAPI_KEY>';
const API_URL = 'https://api.aimlapi.com/v1/chat/completions';

async function completeChat() {
    const requestBody = {
        model: "bagoodex/bagoodex-search-v1",
        messages: [
            {
                role: "user",
                content: "how to make a slingshot"
            }
        ]
    };

    try {
        const response = await fetch(API_URL, {
            method: "POST",
            headers: {
                "Content-Type": "application/json",
                "Authorization": `Bearer ${API_KEY}`
            },
            body: JSON.stringify(requestBody)
        });

        const data = await response.json();
        console.log(data.choices[0].message.content);
    } catch (error) {
        console.error("Error fetching completion:", error);
    }
}

// Run the function
completeChat();

Response

To make a slingshot, you can follow the instructions provided in the two sources:

**Option 1: Make a Giant Slingshot**

* Start by cutting two 2x4's to a length of 40 inches each, which will be the main arms of the slingshot.
* Attach the arms to a base made of plywood using screws, and then add side braces to support the arms.
* Install an exercise band as the launching mechanism, making sure to tighten it to achieve the desired distance.
* Add a cross brace to keep the arms rigid and prevent them from spreading or caving in.

**Option 2: Make a Stick Slingshot**

* Find a sturdy, Y-shaped stick and break it down to the desired shape.
* Cut notches on the ends of the stick to hold the rubber bands in place.
* Create a pouch by folding a piece of fabric in half and then half again, and then cutting small holes for the rubber bands.        
* Thread the rubber bands through the holes and tie them securely to the stick using thread.
* Decorate the slingshot with coloured yarn or twine if desired.

You can choose to make either a giant slingshot or a stick slingshot, depending on your preference and the materials available.

Example #2: Using the IP Parameter for Personalized Model Output

When using regular search engines in browsers, we can simply ask, 'Weather today' without specifying our location. In this case, the search engine automatically uses your IP address to determine your location and provide a more relevant response. The AI Search Engine also supports IP-based personalization.

In the example below, the query does not specify a city, but since the request includes an IP address registered in Stockholm, the system automatically adjusts, and the response will contain today's weather forecast for that city.

Note that when making a request via Python, the ip parameter should be included inside the extra_body parameter (see example below). When using other languages, this is not required, and the ip parameter can be passed like any other parameter.

import requests
from openai import OpenAI

# Insert your AIML API Key instead of <YOUR_AIMLAPI_KEY>:
API_KEY = '<YOUR_AIMLAPI_KEY>'
API_URL = 'https://api.aimlapi.com'

# Call the standart chat completion endpoint to get an ID
def complete_chat():
    client = OpenAI(
        base_url=API_URL,
        api_key=API_KEY,
    )    

    response = client.chat.completions.create(
        model="bagoodex/bagoodex-search-v1",
        messages=[
            {
                "role": "user",
                "content": "Weather today",
            },
        ],
        
        # insert your IP into this section
        extra_body={
            'ip': '192.44.242.19' # we used a random IP address from Stockholm
        }
    )
    print(response.choices[0].message.content)
    return response


# Run the function
complete_chat()

import fetch from 'node-fetch';

// Insert your AIML API Key instead of <YOUR_AIMLAPI_KEY>:
const API_KEY = '<YOUR_AIMLAPI_KEY>';
const API_URL = 'https://api.aimlapi.com/v1/chat/completions';

async function completeChat() {
    const requestBody = {
        model: "bagoodex/bagoodex-search-v1",
        messages: [
            {
                role: "user",
                content: "Weather today"
            }
        ],
        extra_body: {
            ip: "192.44.242.19" // We used a random IP address from Stockholm
        }
    };

    try {
        const response = await fetch(API_URL, {
            method: 'POST',
            headers: {
                'Content-Type': 'application/json',
                'Authorization': `Bearer ${API_KEY}`
            },
            body: JSON.stringify(requestBody)
        });
        
        const data = await response.json();
        console.log(data.choices[0].message.content);
        return data;
    } catch (error) {
        console.error('Error:', error);
    }
}

// Run the function
completeChat();

Response When Using IP Parameter

"According to the forecast, today's weather in Stockholm is partly cloudy with light winds. The temperature is expected to be around 6°C (43°F) with a gentle breeze. \n\nThe forecast also mentions that the weather will be sunny intervals and light winds throughout the day."

Keep in mind that the system caches the IP address for a period of two weeks. This means that after specifying an IP address once, any queries without an explicit location will continue to return responses linked to Stockholm for the next two weeks, even if you don't include the IP address in subsequent requests. If you need to change the location, simply provide a new IP address in your next request.

If an IP address registered in one location is used while explicitly specifying a different location in the query, AI Search Engine will prioritize the location from the query:

Response when the IP parameter is used (from Stockholm), but the request also includes a different location (San Francisco)

"According to the weather forecast, today in San Francisco, there will be a strong cold front moving through the Bay Area from late morning into the afternoon, boosting wind speeds with gusts at around 45 mph midday and featuring high rain rates at times. This may lead to localized runoff issues. The high temperature is expected to be around 56F, with a chance of rain 100% and rainfall near a half an inch. \n\nYou can check the latest forecast and weather conditions on websites such as [https://weather.com/weather/today/l/USCA0987:1:US] or [https://www.accuweather.com/en/us/san-francisco/94103/weather-forecast/347629]."

PreviousBagoodex NextFind Links

Last updated 3 days ago

Was this helpful?

Overview

See API references and examples on the subpages.

How to make a call

Check how this call is made in the examples below.

Note that queries can include advanced search syntax:

Search for an exact match: Enter a word or phrase using \" before and after it. For example, \"tallest building\".
Search for a specific site: Enter site: in front of a site or domain. For example, site:youtube.com cat videos.
Exclude words from your search: Enter - in front of a word that you want to leave out. For example, jaguar speed -car.

You can also personalize the AI Search Engine output by passing the ip parameter. See Example #2 below.

API Schema

Example #1

import requests
from openai import OpenAI

# Insert your AIML API Key instead of <YOUR_AIMLAPI_KEY>:
API_KEY = '<YOUR_AIMLAPI_KEY>'
API_URL = 'https://api.aimlapi.com'

def complete_chat():
    client = OpenAI(
        base_url=API_URL,
        api_key=API_KEY,
    )    

    response = client.chat.completions.create(
        model="bagoodex/bagoodex-search-v1",
        messages=[
            {
                "role": "user",
                
                # Enter your query here
                "content": 'how to make a slingshot',
            },
        ],
    )
    
    
    print(response.choices[0].message.content)


# Run the function
complete_chat()

// Insert your AIML API Key instead of <YOUR_AIMLAPI_KEY>:
const API_KEY = '<YOUR_AIMLAPI_KEY>';
const API_URL = 'https://api.aimlapi.com/v1/chat/completions';

async function completeChat() {
    const requestBody = {
        model: "bagoodex/bagoodex-search-v1",
        messages: [
            {
                role: "user",
                content: "how to make a slingshot"
            }
        ]
    };

    try {
        const response = await fetch(API_URL, {
            method: "POST",
            headers: {
                "Content-Type": "application/json",
                "Authorization": `Bearer ${API_KEY}`
            },
            body: JSON.stringify(requestBody)
        });

        const data = await response.json();
        console.log(data.choices[0].message.content);
    } catch (error) {
        console.error("Error fetching completion:", error);
    }
}

// Run the function
completeChat();

Response

To make a slingshot, you can follow the instructions provided in the two sources:

**Option 1: Make a Giant Slingshot**

* Start by cutting two 2x4's to a length of 40 inches each, which will be the main arms of the slingshot.
* Attach the arms to a base made of plywood using screws, and then add side braces to support the arms.
* Install an exercise band as the launching mechanism, making sure to tighten it to achieve the desired distance.
* Add a cross brace to keep the arms rigid and prevent them from spreading or caving in.

**Option 2: Make a Stick Slingshot**

* Find a sturdy, Y-shaped stick and break it down to the desired shape.
* Cut notches on the ends of the stick to hold the rubber bands in place.
* Create a pouch by folding a piece of fabric in half and then half again, and then cutting small holes for the rubber bands.        
* Thread the rubber bands through the holes and tie them securely to the stick using thread.
* Decorate the slingshot with coloured yarn or twine if desired.

You can choose to make either a giant slingshot or a stick slingshot, depending on your preference and the materials available.

Example #2: Using the IP Parameter for Personalized Model Output

import requests
from openai import OpenAI

# Insert your AIML API Key instead of <YOUR_AIMLAPI_KEY>:
API_KEY = '<YOUR_AIMLAPI_KEY>'
API_URL = 'https://api.aimlapi.com'

# Call the standart chat completion endpoint to get an ID
def complete_chat():
    client = OpenAI(
        base_url=API_URL,
        api_key=API_KEY,
    )    

    response = client.chat.completions.create(
        model="bagoodex/bagoodex-search-v1",
        messages=[
            {
                "role": "user",
                "content": "Weather today",
            },
        ],
        
        # insert your IP into this section
        extra_body={
            'ip': '192.44.242.19' # we used a random IP address from Stockholm
        }
    )
    print(response.choices[0].message.content)
    return response


# Run the function
complete_chat()

import fetch from 'node-fetch';

// Insert your AIML API Key instead of <YOUR_AIMLAPI_KEY>:
const API_KEY = '<YOUR_AIMLAPI_KEY>';
const API_URL = 'https://api.aimlapi.com/v1/chat/completions';

async function completeChat() {
    const requestBody = {
        model: "bagoodex/bagoodex-search-v1",
        messages: [
            {
                role: "user",
                content: "Weather today"
            }
        ],
        extra_body: {
            ip: "192.44.242.19" // We used a random IP address from Stockholm
        }
    };

    try {
        const response = await fetch(API_URL, {
            method: 'POST',
            headers: {
                'Content-Type': 'application/json',
                'Authorization': `Bearer ${API_KEY}`
            },
            body: JSON.stringify(requestBody)
        });
        
        const data = await response.json();
        console.log(data.choices[0].message.content);
        return data;
    } catch (error) {
        console.error('Error:', error);
    }
}

// Run the function
completeChat();

Response When Using IP Parameter

"According to the forecast, today's weather in Stockholm is partly cloudy with light winds. The temperature is expected to be around 6°C (43°F) with a gentle breeze. \n\nThe forecast also mentions that the weather will be sunny intervals and light winds throughout the day."

If an IP address registered in one location is used while explicitly specifying a different location in the query, AI Search Engine will prioritize the location from the query:

Response when the IP parameter is used (from Stockholm), but the request also includes a different location (San Francisco)

"According to the weather forecast, today in San Francisco, there will be a strong cold front moving through the Bay Area from late morning into the afternoon, boosting wind speeds with gusts at around 45 mph midday and featuring high rain rates at times. This may lead to localized runoff issues. The high temperature is expected to be around 56F, with a chance of rain 100% and rainfall near a half an inch. \n\nYou can check the latest forecast and weather conditions on websites such as [https://weather.com/weather/today/l/USCA0987:1:US] or [https://www.accuweather.com/en/us/san-francisco/94103/weather-forecast/347629]."

Generate a conversational response using a language model.

post

Creates a chat completion using a language model, allowing interactive conversation by predicting the next response based on the given chat history. This is useful for AI-driven dialogue systems and virtual assistants.

Authorizations

Body

modelundefined · enumrequired

Options: bagoodex/bagoodex-search-v1

messagesobject[]required

frequency_penaltynumber | nullableoptional

logit_biasobject | nullableoptional

logprobsboolean | nullableoptional

top_logprobsnumber | nullableoptional

max_tokensnumber · min: 1 · default: 512optional

ninteger | nullableoptional

presence_penaltynumber | nullableoptional

response_formatone ofoptional

seedinteger · min: 1optional

stopany ofoptional

streamboolean · default: falseoptional

temperaturenumber · max: 2optional

top_pnumber · min: 0.1 · max: 1optional

toolsobject[]optionalDeprecated

tool_choiceany ofoptionalDeprecated

userstringoptional

best_ofinteger | nullableoptional

use_beam_searchboolean | nullableoptional

top_kinteger | nullableoptional

min_pnumber | nullableoptional

repetition_penaltynumber | nullableoptional

length_penaltynumber | nullableoptional

early_stoppingboolean | nullableoptional

ignore_eosboolean | nullableoptional

min_tokensinteger | nullableoptional

stop_token_idsinteger[] | nullableoptional

skip_special_tokensboolean | nullableoptional

spaces_between_special_tokensany | nullableoptional

echoboolean | nullableoptional

If true, the new message will be prepended with the last message if they belong to the same role.

add_generation_promptboolean | nullableoptional

If true, the generation prompt will be added to the chat template. This is a parameter used by chat template in tokenizer config of the model.

add_special_tokensboolean | nullableoptional

If true, special tokens (e.g. BOS) will be added to the prompt on top of what is added by the chat template. For most models, the chat template takes care of adding the special tokens so this should be set to False (as is the default).

documentsobject[] | nullableoptional

A list of dicts representing documents that will be accessible to the model if it is performing RAG (retrieval-augmented generation). If the template does not support RAG, this argument will have no effect. We recommend that each document should be a dict containing "title" and "text" keys.

chat_templatestring | nullableoptional

A Jinja template to use for this conversion. If this is not passed, the model's default chat template will be used instead.

chat_template_kwargsobject | nullableoptional

Additional kwargs to pass to the template renderer. Will be accessible by the chat template

include_stop_str_in_outputboolean | nullableoptional

Whether to include the stop string in the output. This is only applied when the stop or stop_token_ids is set

guided_jsonany ofoptional

If specified, the output will follow the JSON schema.

guided_regexstring | nullableoptional

If specified, the output will follow the regex pattern.

guided_choicestring[] | nullableoptional

If specified, the output will be exactly one of the choices.

guided_grammarstring | nullableoptional

If specified, the output will follow the context free grammar.

guided_decoding_backendstring · enum | nullableoptional

If specified, will override the default guided decoding backend of the server for this specific request. If set, must be either 'outlines' / 'lm-format-enforcer'

Options: outlines, lm-format-enforcer

guided_whitespace_patternstring | nullableoptional

If specified, will override the default whitespace pattern for guided json decoding.

ipstring · ipoptional

IP from which a request is executed

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.aimlapi.com/v1/chat/completions' \
  --header 'Authorization: Bearer <YOUR_AIMLAPI_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
    "model": "bagoodex/bagoodex-search-v1",
    "messages": [
      {
        "role": "user",
        "content": "text"
      }
    ],
    "frequency_penalty": 1,
    "logit_bias": {
      "ANY_ADDITIONAL_PROPERTY": 1
    },
    "logprobs": true,
    "top_logprobs": 1,
    "max_tokens": 1,
    "n": 1,
    "presence_penalty": 1,
    "response_format": {
      "type": "text"
    },
    "seed": 1,
    "stop": "text",
    "stream": true,
    "temperature": 1,
    "top_p": 1,
    "tools": [
      {
        "type": "function",
        "function": {
          "description": "text",
          "name": "text",
          "parameters": null,
          "required": [
            "text"
          ]
        }
      }
    ],
    "tool_choice": "none",
    "user": "text",
    "best_of": 1,
    "use_beam_search": true,
    "top_k": 1,
    "min_p": 1,
    "repetition_penalty": 1,
    "length_penalty": 1,
    "early_stopping": true,
    "ignore_eos": true,
    "min_tokens": 1,
    "stop_token_ids": [
      1
    ],
    "skip_special_tokens": true,
    "spaces_between_special_tokens": null,
    "echo": true,
    "add_generation_prompt": true,
    "add_special_tokens": true,
    "documents": [
      {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    ],
    "chat_template": "text",
    "chat_template_kwargs": {
      "ANY_ADDITIONAL_PROPERTY": null
    },
    "include_stop_str_in_output": true,
    "guided_json": "text",
    "guided_regex": "text",
    "guided_choice": [
      "text"
    ],
    "guided_grammar": "text",
    "guided_decoding_backend": "outlines",
    "guided_whitespace_pattern": "text",
    "ip": "text"
  }'

201

No body

Overview

How to make a call

API Schema

Example #1

Example #2: Using the IP Parameter for Personalized Model Output

Overview

How to make a call

API Schema

Example #1

Example #2: Using the IP Parameter for Personalized Model Output

Generate a conversational response using a language model.

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show string

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes