Archive an assistant (blocked by active deployments)
Archive an assistant. Blocked by active phone/email/team bindings (§8).
POST
/
v1
/
assistants
/
{agent_id}
/
archive
Archive an assistant (blocked by active deployments)
curl --request POST \
--url https://api-sandbox.featherhq.com/v1/assistants/{agent_id}/archive \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"reason": "<string>"
}
'import requests
url = "https://api-sandbox.featherhq.com/v1/assistants/{agent_id}/archive"
payload = { "reason": "<string>" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({reason: '<string>'})
};
fetch('https://api-sandbox.featherhq.com/v1/assistants/{agent_id}/archive', 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-sandbox.featherhq.com/v1/assistants/{agent_id}/archive",
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([
'reason' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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-sandbox.featherhq.com/v1/assistants/{agent_id}/archive"
payload := strings.NewReader("{\n \"reason\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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-sandbox.featherhq.com/v1/assistants/{agent_id}/archive")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.featherhq.com/v1/assistants/{agent_id}/archive")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"active_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"active_revision": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"system_context_variables": [
{
"name": "<string>",
"type": "string",
"enum_values": [
"<string>"
],
"description": "<string>"
}
],
"description": "<string>",
"persona": "<string>",
"system_prompt": "<string>",
"context_variables": [
{
"name": "<string>",
"type": "string",
"source": "derived",
"enum_values": [
"<string>"
],
"reask_cap": 123,
"description": "<string>"
}
],
"variable_defaults": {},
"tool_refs": [
{}
],
"knowledge_base_refs": [
{}
],
"platform_tools": {},
"policies_enabled": true,
"policy_refs": [
{}
],
"channel_specific_config": {},
"router_config_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"model_settings": {
"model": "<string>",
"config": {
"temperature": 1,
"max_tokens": 2,
"top_p": 0.5,
"stop_sequences": [
"<string>"
],
"reasoning_effort": "none",
"request_timeout_ms": 10500,
"thinking_budget": 2
}
},
"analyzer_model_settings": {
"model": "<string>",
"config": {
"temperature": 1,
"max_tokens": 2,
"top_p": 0.5,
"stop_sequences": [
"<string>"
],
"reasoning_effort": "none",
"request_timeout_ms": 10500,
"thinking_budget": 2
}
},
"workflow_enabled": false,
"memory_enabled": true,
"current_time": {
"enabled": true,
"timezone": "<string>"
},
"kb_clearance_level": 123,
"kb_audience_tags": [
"<string>"
],
"continue_after_flow": true,
"voice_call_settings": {},
"created_by": "<string>",
"published_at": "2023-11-07T05:31:56Z"
},
"metadata": {},
"platform_tools": {},
"knowledge_gap_analysis_enabled": true,
"release_suite_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"release_gate_mode": "off",
"release_gate_max_failures": 0,
"max_active_calls": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Path Parameters
Body
application/json
Request body for POST /assistants/{id}/archive (§8).
Maximum string length:
1000Response
Successful Response
Show child attributes
Show child attributes
Per-agent release-gate mode (ENG-727). off = no release checks;
advisory = compute + display a verdict but never block activation.
The gate always runs and surfaces a verdict; it never refuses activation.
Available options:
off, advisory Was this page helpful?
⌘I
Archive an assistant (blocked by active deployments)
curl --request POST \
--url https://api-sandbox.featherhq.com/v1/assistants/{agent_id}/archive \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"reason": "<string>"
}
'import requests
url = "https://api-sandbox.featherhq.com/v1/assistants/{agent_id}/archive"
payload = { "reason": "<string>" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({reason: '<string>'})
};
fetch('https://api-sandbox.featherhq.com/v1/assistants/{agent_id}/archive', 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-sandbox.featherhq.com/v1/assistants/{agent_id}/archive",
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([
'reason' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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-sandbox.featherhq.com/v1/assistants/{agent_id}/archive"
payload := strings.NewReader("{\n \"reason\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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-sandbox.featherhq.com/v1/assistants/{agent_id}/archive")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.featherhq.com/v1/assistants/{agent_id}/archive")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"active_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"active_revision": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"system_context_variables": [
{
"name": "<string>",
"type": "string",
"enum_values": [
"<string>"
],
"description": "<string>"
}
],
"description": "<string>",
"persona": "<string>",
"system_prompt": "<string>",
"context_variables": [
{
"name": "<string>",
"type": "string",
"source": "derived",
"enum_values": [
"<string>"
],
"reask_cap": 123,
"description": "<string>"
}
],
"variable_defaults": {},
"tool_refs": [
{}
],
"knowledge_base_refs": [
{}
],
"platform_tools": {},
"policies_enabled": true,
"policy_refs": [
{}
],
"channel_specific_config": {},
"router_config_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"model_settings": {
"model": "<string>",
"config": {
"temperature": 1,
"max_tokens": 2,
"top_p": 0.5,
"stop_sequences": [
"<string>"
],
"reasoning_effort": "none",
"request_timeout_ms": 10500,
"thinking_budget": 2
}
},
"analyzer_model_settings": {
"model": "<string>",
"config": {
"temperature": 1,
"max_tokens": 2,
"top_p": 0.5,
"stop_sequences": [
"<string>"
],
"reasoning_effort": "none",
"request_timeout_ms": 10500,
"thinking_budget": 2
}
},
"workflow_enabled": false,
"memory_enabled": true,
"current_time": {
"enabled": true,
"timezone": "<string>"
},
"kb_clearance_level": 123,
"kb_audience_tags": [
"<string>"
],
"continue_after_flow": true,
"voice_call_settings": {},
"created_by": "<string>",
"published_at": "2023-11-07T05:31:56Z"
},
"metadata": {},
"platform_tools": {},
"knowledge_gap_analysis_enabled": true,
"release_suite_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"release_gate_mode": "off",
"release_gate_max_failures": 0,
"max_active_calls": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}