Explain Search Results

Explain search results

POST https://api.aisa.one/apis/v1/scholar/search/explain

Explain search results

cURL

curl --request POST \
  --url https://api.aisa.one/apis/v1/scholar/search/explain \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "search_id": "<string>",
  "response_mode": "NON_STREAMING",
  "language": "ar",
  "detail_level": "MODERATE"
}
'

import requests

url = "https://api.aisa.one/apis/v1/scholar/search/explain"

payload = {
    "search_id": "<string>",
    "response_mode": "NON_STREAMING",
    "language": "ar",
    "detail_level": "MODERATE"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    search_id: '<string>',
    response_mode: 'NON_STREAMING',
    language: 'ar',
    detail_level: 'MODERATE'
  })
};

fetch('https://api.aisa.one/apis/v1/scholar/search/explain', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.aisa.one/apis/v1/scholar/search/explain",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'search_id' => '<string>',
    'response_mode' => 'NON_STREAMING',
    'language' => 'ar',
    'detail_level' => 'MODERATE'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.aisa.one/apis/v1/scholar/search/explain"

	payload := strings.NewReader("{\n  \"search_id\": \"<string>\",\n  \"response_mode\": \"NON_STREAMING\",\n  \"language\": \"ar\",\n  \"detail_level\": \"MODERATE\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.aisa.one/apis/v1/scholar/search/explain")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"search_id\": \"<string>\",\n  \"response_mode\": \"NON_STREAMING\",\n  \"language\": \"ar\",\n  \"detail_level\": \"MODERATE\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/scholar/search/explain")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"search_id\": \"<string>\",\n  \"response_mode\": \"NON_STREAMING\",\n  \"language\": \"ar\",\n  \"detail_level\": \"MODERATE\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "message": "<string>"
}

{
  "error": "<string>",
  "code": 123,
  "details": "<string>"
}

{
  "error": "<string>",
  "code": 123,
  "details": "<string>"
}

{
  "error": "<string>",
  "code": 123,
  "details": "<string>"
}

{
  "error": "<string>",
  "code": 123,
  "details": "<string>"
}

{
  "error": "<string>",
  "code": 123,
  "details": "<string>"
}

Generate an explanation from a previous Scholar Search, Web Search, or Smart Search request. Pass the returned search id as search_id.

Best for: Summarizing search results, producing localized explanations, and turning search output into a readable answer.

Example

curl -X POST "https://api.aisa.one/apis/v1/scholar/search/explain" \
  -H "Authorization: Bearer ${AISA_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "search_id": "search_id",
    "response_mode": "NON_STREAMING",
    "language": "en",
    "detail_level": "BRIEF"
  }'

Response

NON_STREAMING returns a JSON object with a message field. COMPLETE and INCREMENTAL stream server-sent events for clients that can consume streaming responses.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

search_id · string · required

ID of the search to explain

response_mode · enum<string> · default: NON_STREAMING

Format of the explanation response. COMPLETE and INCREMENTAL stream server-sent events; NON_STREAMING returns a JSON response.

Available options: COMPLETE, INCREMENTAL, NON_STREAMING

language · string · default: en

Language code for the explanation (e.g., en, zh, ar)

Example:

"ar"

detail_level · enum<string> · default: MODERATE

Level of detail in the explanation

Available options: BRIEF, MODERATE, DETAILED

Response

200

application/json

Successful explanation response. COMPLETE/INCREMENTAL stream text/event-stream; NON_STREAMING returns application/json.

JSON explanation response returned when response_mode is NON_STREAMING.

message · string · required

Generated explanation text.