Find Images
Overview
This is a description of one of the six use cases for the AI Search Engine model—retrieving internet images related to the requested subject.
How to make a call
Check how this call is made in the example 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.
API Schema
GET /v1/bagoodex/images HTTP/1.1
Host: api.aimlapi.com
Authorization: Bearer <YOUR_AIMLAPI_KEY>
Accept: */*
[
{
"source": "text",
"original": "https://example.com",
"title": "text",
"source_name": "text"
}
]Example
First, the standard chat completion endpoint with your query is called. It returns an ID, which must then be passed as the sole input parameter followup_id to the specific second endpoint:
import requests
from openai import OpenAI
# Insert your AIML API Key instead of <YOUR_API_KEY>:
API_KEY = '<YOUR_API_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": "giant dragonflies",
},
],
)
# Extract the ID from the response
gen_id = response.id
print(f"Generated ID: {gen_id}")
# Call the second endpoint with the generated ID
get_images(gen_id)
def get_images(gen_id):
params = {'followup_id': gen_id}
headers = {'Authorization': f'Bearer {API_KEY}'}
response = requests.get(f'{API_URL}/v1/bagoodex/images', headers=headers, params=params)
print(response.json())
# Run the function
complete_chat()Last updated
Was this helpful?