Skip to main content
POST
/
v1
/
agents
/
handoff
Agent Handoff
curl --request POST \
  --url https://api.example.com/v1/agents/handoff \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "working_context": "<string>",
  "code_location": "<string>"
}
'
import requests

url = "https://api.example.com/v1/agents/handoff"

payload = {
    "email": "<string>",
    "working_context": "<string>",
    "code_location": "<string>"
}
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({email: '<string>', working_context: '<string>', code_location: '<string>'})
};

fetch('https://api.example.com/v1/agents/handoff', 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/v1/agents/handoff",
  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([
    'email' => '<string>',
    'working_context' => '<string>',
    'code_location' => '<string>'
  ]),
  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.example.com/v1/agents/handoff"

	payload := strings.NewReader("{\n  \"email\": \"<string>\",\n  \"working_context\": \"<string>\",\n  \"code_location\": \"<string>\"\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.example.com/v1/agents/handoff")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"<string>\",\n  \"working_context\": \"<string>\",\n  \"code_location\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/agents/handoff")

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  \"email\": \"<string>\",\n  \"working_context\": \"<string>\",\n  \"code_location\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
authorization
string | null

Body

application/json
​
email
string
required

Your human operator's email. A one-time link to adopt this account is sent there.

Maximum string length: 255
​
working_context
string | null

Recommended: a short, human-readable description of where you are running, so your operator recognizes the email and it isn't mistaken for spam (e.g. 'the ~/Documents/acme project on your Mac', or 'the Acme Slack workspace').

Maximum string length: 300
​
code_location
string | null

Optional: where you show or save the takeover code so your operator can find it (e.g. 'this chat', or '~/.superdocs/takeover-code.txt').

Maximum string length: 300

Response

Successful Response