Recall approved relationship source evidence
Requires the configured Aida workspace feature (aida_workspace by default). View permits aida_view/capture/review/settings_manage or full access; mutation requires the action-specific capture, review or settings permission. All records belong to the current organization. Searches currently allowed source types using operational search and embedding similarity, with database/deterministic fallback when configured. Restricted/sensitive sources are excluded. limit applies per search channel, default five.
curl --request POST \
--url https://api.gratona.com/v1/admin/aida/recall \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "<string>",
"source_type": "<string>",
"freshness_state": "<string>",
"work_item_id": 2,
"limit": 5
}
'import requests
url = "https://api.gratona.com/v1/admin/aida/recall"
payload = {
"query": "<string>",
"source_type": "<string>",
"freshness_state": "<string>",
"work_item_id": 2,
"limit": 5
}
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({
query: '<string>',
source_type: '<string>',
freshness_state: '<string>',
work_item_id: 2,
limit: 5
})
};
fetch('https://api.gratona.com/v1/admin/aida/recall', 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.gratona.com/v1/admin/aida/recall",
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([
'query' => '<string>',
'source_type' => '<string>',
'freshness_state' => '<string>',
'work_item_id' => 2,
'limit' => 5
]),
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.gratona.com/v1/admin/aida/recall"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"source_type\": \"<string>\",\n \"freshness_state\": \"<string>\",\n \"work_item_id\": 2,\n \"limit\": 5\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.gratona.com/v1/admin/aida/recall")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"source_type\": \"<string>\",\n \"freshness_state\": \"<string>\",\n \"work_item_id\": 2,\n \"limit\": 5\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/aida/recall")
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 \"query\": \"<string>\",\n \"source_type\": \"<string>\",\n \"freshness_state\": \"<string>\",\n \"work_item_id\": 2,\n \"limit\": 5\n}"
response = http.request(request)
puts response.read_body{
"data": {
"query": "<string>",
"allowed_source_types": [
"<string>"
],
"operational_search": {
"status": "<string>",
"engine": "<string>",
"results": [
{
"source_context_id": 123,
"work_item_id": 123,
"source_type": "<string>",
"source_record_type": "<string>",
"relationship_name": "<string>",
"title": "<string>",
"summary": "<string>",
"permission_class": "<string>",
"freshness_state": "<string>",
"source_restricted": true,
"why_this_surfaced": "<string>",
"score": 123,
"matched_terms": [
"<string>"
]
}
]
},
"semantic_recall": {
"status": "<string>",
"engine": "<string>",
"provider": "<string>",
"model": "<string>",
"results": [
{
"source_context_id": 123,
"work_item_id": 123,
"source_type": "<string>",
"source_record_type": "<string>",
"relationship_name": "<string>",
"title": "<string>",
"summary": "<string>",
"permission_class": "<string>",
"freshness_state": "<string>",
"source_restricted": true,
"why_this_surfaced": "<string>",
"score": 123,
"matched_terms": [
"<string>"
]
}
]
}
}
}{
"message": "Unauthorized",
"status": "error"
}{
"message": "Something went wrong. Please try again.",
"status": "error",
"error": "invalid_request",
"code": "DONOR_NOT_FOUND"
}{
"errors": {},
"status": "error",
"message": "The given data was invalid."
}Authorizations
Passport bearer token authentication for legacy admin sessions.
Body
Request fields accepted by this operation. Omitted optional properties retain the behavior described above.
Validation: required|string|max:500.
500Validation: nullable|string|max:64.
64Validation: nullable|string|max:32.
32Validation: integer|min:1.
x >= 1Validation: integer|min:1|max:10.
1 <= x <= 10Response
Recall approved relationship source evidence response.
Show child attributes
Show child attributes
curl --request POST \
--url https://api.gratona.com/v1/admin/aida/recall \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "<string>",
"source_type": "<string>",
"freshness_state": "<string>",
"work_item_id": 2,
"limit": 5
}
'import requests
url = "https://api.gratona.com/v1/admin/aida/recall"
payload = {
"query": "<string>",
"source_type": "<string>",
"freshness_state": "<string>",
"work_item_id": 2,
"limit": 5
}
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({
query: '<string>',
source_type: '<string>',
freshness_state: '<string>',
work_item_id: 2,
limit: 5
})
};
fetch('https://api.gratona.com/v1/admin/aida/recall', 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.gratona.com/v1/admin/aida/recall",
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([
'query' => '<string>',
'source_type' => '<string>',
'freshness_state' => '<string>',
'work_item_id' => 2,
'limit' => 5
]),
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.gratona.com/v1/admin/aida/recall"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"source_type\": \"<string>\",\n \"freshness_state\": \"<string>\",\n \"work_item_id\": 2,\n \"limit\": 5\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.gratona.com/v1/admin/aida/recall")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"source_type\": \"<string>\",\n \"freshness_state\": \"<string>\",\n \"work_item_id\": 2,\n \"limit\": 5\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/aida/recall")
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 \"query\": \"<string>\",\n \"source_type\": \"<string>\",\n \"freshness_state\": \"<string>\",\n \"work_item_id\": 2,\n \"limit\": 5\n}"
response = http.request(request)
puts response.read_body{
"data": {
"query": "<string>",
"allowed_source_types": [
"<string>"
],
"operational_search": {
"status": "<string>",
"engine": "<string>",
"results": [
{
"source_context_id": 123,
"work_item_id": 123,
"source_type": "<string>",
"source_record_type": "<string>",
"relationship_name": "<string>",
"title": "<string>",
"summary": "<string>",
"permission_class": "<string>",
"freshness_state": "<string>",
"source_restricted": true,
"why_this_surfaced": "<string>",
"score": 123,
"matched_terms": [
"<string>"
]
}
]
},
"semantic_recall": {
"status": "<string>",
"engine": "<string>",
"provider": "<string>",
"model": "<string>",
"results": [
{
"source_context_id": 123,
"work_item_id": 123,
"source_type": "<string>",
"source_record_type": "<string>",
"relationship_name": "<string>",
"title": "<string>",
"summary": "<string>",
"permission_class": "<string>",
"freshness_state": "<string>",
"source_restricted": true,
"why_this_surfaced": "<string>",
"score": 123,
"matched_terms": [
"<string>"
]
}
]
}
}
}{
"message": "Unauthorized",
"status": "error"
}{
"message": "Something went wrong. Please try again.",
"status": "error",
"error": "invalid_request",
"code": "DONOR_NOT_FOUND"
}{
"errors": {},
"status": "error",
"message": "The given data was invalid."
}