Skip to main content
POST
/
agents
/
assists
/
suggest-assignee
Suggest Assignee
curl --request POST \
  --url https://api.example.com/agents/assists/suggest-assignee \
  --header 'Content-Type: application/json' \
  --data '
{
  "task_id": "<string>",
  "candidates": [
    {
      "instance_id": "<string>",
      "type": "<string>",
      "current_load": 123,
      "recent_tasks": [
        "<string>"
      ]
    }
  ]
}
'
import requests

url = "https://api.example.com/agents/assists/suggest-assignee"

payload = {
    "task_id": "<string>",
    "candidates": [
        {
            "instance_id": "<string>",
            "type": "<string>",
            "current_load": 123,
            "recent_tasks": ["<string>"]
        }
    ]
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    task_id: '<string>',
    candidates: [
      {
        instance_id: '<string>',
        type: '<string>',
        current_load: 123,
        recent_tasks: ['<string>']
      }
    ]
  })
};

fetch('https://api.example.com/agents/assists/suggest-assignee', 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.example.com/agents/assists/suggest-assignee",
  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([
    'task_id' => '<string>',
    'candidates' => [
        [
                'instance_id' => '<string>',
                'type' => '<string>',
                'current_load' => 123,
                'recent_tasks' => [
                                '<string>'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "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.example.com/agents/assists/suggest-assignee"

	payload := strings.NewReader("{\n  \"task_id\": \"<string>\",\n  \"candidates\": [\n    {\n      \"instance_id\": \"<string>\",\n      \"type\": \"<string>\",\n      \"current_load\": 123,\n      \"recent_tasks\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}")

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

	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.example.com/agents/assists/suggest-assignee")
  .header("Content-Type", "application/json")
  .body("{\n  \"task_id\": \"<string>\",\n  \"candidates\": [\n    {\n      \"instance_id\": \"<string>\",\n      \"type\": \"<string>\",\n      \"current_load\": 123,\n      \"recent_tasks\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/agents/assists/suggest-assignee")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"task_id\": \"<string>\",\n  \"candidates\": [\n    {\n      \"instance_id\": \"<string>\",\n      \"type\": \"<string>\",\n      \"current_load\": 123,\n      \"recent_tasks\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "instance_id": "<string>",
  "rationale": "<string>",
  "confidence": 123
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Body

application/json

Request body for the suggest-assignee assist.

Attributes: task_id: Task to assign. candidates: Eligible agent instances for the assist to rank.

task_id
string
required
candidates
AssigneeCandidate · object[]
required

Response

Successful Response

Response body for the suggest-assignee assist.

Attributes: instance_id: Recommended agent instance identifier. rationale: Short explanation of why this candidate was picked. confidence: Model confidence in the suggestion, in [0.0, 1.0].

instance_id
string
required
rationale
string
required
confidence
number
required