Screen a batch of keywords against the knowledge base
curl --request POST \
--url https://app.amoreg.com/api/v1/screenings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"keywords": [
"<string>"
],
"jurisdictions": [
"<string>"
],
"topK": 5
}
'import requests
url = "https://app.amoreg.com/api/v1/screenings"
payload = {
"keywords": ["<string>"],
"jurisdictions": ["<string>"],
"topK": 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({keywords: ['<string>'], jurisdictions: ['<string>'], topK: 5})
};
fetch('https://app.amoreg.com/api/v1/screenings', 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://app.amoreg.com/api/v1/screenings",
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([
'keywords' => [
'<string>'
],
'jurisdictions' => [
'<string>'
],
'topK' => 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://app.amoreg.com/api/v1/screenings"
payload := strings.NewReader("{\n \"keywords\": [\n \"<string>\"\n ],\n \"jurisdictions\": [\n \"<string>\"\n ],\n \"topK\": 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://app.amoreg.com/api/v1/screenings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"keywords\": [\n \"<string>\"\n ],\n \"jurisdictions\": [\n \"<string>\"\n ],\n \"topK\": 5\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.amoreg.com/api/v1/screenings")
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 \"keywords\": [\n \"<string>\"\n ],\n \"jurisdictions\": [\n \"<string>\"\n ],\n \"topK\": 5\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"status": "<string>",
"estimatedCostPence": 123
}{
"error": "<string>",
"details": "<string>"
}Screenings
Create a screening
Durable background run: reserves 2p per keyword up front, settles the actual cost when the run completes, and releases the remainder. Poll GET /screenings/ for results.
POST
/
screenings
Screen a batch of keywords against the knowledge base
curl --request POST \
--url https://app.amoreg.com/api/v1/screenings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"keywords": [
"<string>"
],
"jurisdictions": [
"<string>"
],
"topK": 5
}
'import requests
url = "https://app.amoreg.com/api/v1/screenings"
payload = {
"keywords": ["<string>"],
"jurisdictions": ["<string>"],
"topK": 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({keywords: ['<string>'], jurisdictions: ['<string>'], topK: 5})
};
fetch('https://app.amoreg.com/api/v1/screenings', 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://app.amoreg.com/api/v1/screenings",
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([
'keywords' => [
'<string>'
],
'jurisdictions' => [
'<string>'
],
'topK' => 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://app.amoreg.com/api/v1/screenings"
payload := strings.NewReader("{\n \"keywords\": [\n \"<string>\"\n ],\n \"jurisdictions\": [\n \"<string>\"\n ],\n \"topK\": 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://app.amoreg.com/api/v1/screenings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"keywords\": [\n \"<string>\"\n ],\n \"jurisdictions\": [\n \"<string>\"\n ],\n \"topK\": 5\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.amoreg.com/api/v1/screenings")
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 \"keywords\": [\n \"<string>\"\n ],\n \"jurisdictions\": [\n \"<string>\"\n ],\n \"topK\": 5\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"status": "<string>",
"estimatedCostPence": 123
}{
"error": "<string>",
"details": "<string>"
}Authorizations
Organisation API key created in the dashboard (format: amrg_live_…). Sent as Authorization: Bearer amrg_live_….
Body
application/json
⌘I