Archive an Agent

curl --request POST \
  --url https://api.checkfu.com/v1/agents/{agent_id}/archive \
  --header 'Authorization: Bearer <token>' \
  --header 'checkfu-beta: <checkfu-beta>' \
  --header 'checkfu-version: <checkfu-version>'

import requests

url = "https://api.checkfu.com/v1/agents/{agent_id}/archive"

headers = {
    "checkfu-version": "<checkfu-version>",
    "checkfu-beta": "<checkfu-beta>",
    "Authorization": "Bearer <token>"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'checkfu-version': '<checkfu-version>',
    'checkfu-beta': '<checkfu-beta>',
    Authorization: 'Bearer <token>'
  }
};

fetch('https://api.checkfu.com/v1/agents/{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.checkfu.com/v1/agents/{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_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "checkfu-beta: <checkfu-beta>",
    "checkfu-version: <checkfu-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.checkfu.com/v1/agents/{agent_id}/archive"

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

	req.Header.Add("checkfu-version", "<checkfu-version>")
	req.Header.Add("checkfu-beta", "<checkfu-beta>")
	req.Header.Add("Authorization", "Bearer <token>")

	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.checkfu.com/v1/agents/{agent_id}/archive")
  .header("checkfu-version", "<checkfu-version>")
  .header("checkfu-beta", "<checkfu-beta>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/agents/{agent_id}/archive")

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

request = Net::HTTP::Post.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["checkfu-beta"] = '<checkfu-beta>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "archived_at": "<string>",
  "created_at": "<string>",
  "model": {
    "id": "<string>",
    "effort": {
      "type": "low"
    },
    "inference_geo": "global",
    "speed": "standard"
  },
  "name": "<string>",
  "description": "<string>",
  "mcp_servers": [
    {
      "type": "url",
      "name": "<string>",
      "url": "<string>"
    }
  ],
  "metadata": {},
  "multiagent": {
    "type": "coordinator",
    "agents": [
      {
        "type": "agent",
        "id": "<string>",
        "version": 1
      }
    ]
  },
  "skills": [
    {
      "type": "anthropic",
      "skill_id": "<string>",
      "version": "<string>"
    }
  ],
  "system": "<string>",
  "tools": [
    {
      "type": "agent_toolset_20260401",
      "configs": [
        {
          "name": "bash",
          "type": "bash",
          "enabled": true,
          "permission_policy": {
            "type": "always_allow"
          }
        }
      ],
      "default_config": {
        "enabled": true,
        "permission_policy": {
          "type": "always_allow"
        }
      }
    }
  ],
  "type": "agent",
  "updated_at": "<string>",
  "version": 1
}

{
  "error": {
    "type": "validation.malformed",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-malformed"
  }
}

{
  "error": {
    "type": "auth.invalid_key",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-invalid-key"
  }
}

{
  "error": {
    "type": "auth.disabled_tenancy",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
  }
}

{
  "error": {
    "type": "validation.not_found",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-not-found"
  }
}

{
  "error": {
    "type": "validation.conflict",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-conflict"
  }
}

{
  "error": {
    "type": "budget.exceeded",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#budget-exceeded"
  }
}

{
  "error": {
    "type": "runtime.internal",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#runtime-internal"
  }
}

Archive an Agent

Irreversibly archives the Agent. Existing Sessions and immutable Versions remain readable, while updates and new Session selection are refused. Repeating the archive returns the archived Agent; an Idempotency-Key makes transport retries recover the same response.

Checkfu support posture: alpha; hosted. Required evidence journey: agent-definition. Deployment-specific readiness and the latest proven release are available from GET /v1/support/capabilities.

POST

agents

{agent_id}

archive

Archive an Agent

curl --request POST \
  --url https://api.checkfu.com/v1/agents/{agent_id}/archive \
  --header 'Authorization: Bearer <token>' \
  --header 'checkfu-beta: <checkfu-beta>' \
  --header 'checkfu-version: <checkfu-version>'

import requests

url = "https://api.checkfu.com/v1/agents/{agent_id}/archive"

headers = {
    "checkfu-version": "<checkfu-version>",
    "checkfu-beta": "<checkfu-beta>",
    "Authorization": "Bearer <token>"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'checkfu-version': '<checkfu-version>',
    'checkfu-beta': '<checkfu-beta>',
    Authorization: 'Bearer <token>'
  }
};

fetch('https://api.checkfu.com/v1/agents/{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.checkfu.com/v1/agents/{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_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "checkfu-beta: <checkfu-beta>",
    "checkfu-version: <checkfu-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.checkfu.com/v1/agents/{agent_id}/archive"

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

	req.Header.Add("checkfu-version", "<checkfu-version>")
	req.Header.Add("checkfu-beta", "<checkfu-beta>")
	req.Header.Add("Authorization", "Bearer <token>")

	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.checkfu.com/v1/agents/{agent_id}/archive")
  .header("checkfu-version", "<checkfu-version>")
  .header("checkfu-beta", "<checkfu-beta>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/agents/{agent_id}/archive")

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

request = Net::HTTP::Post.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["checkfu-beta"] = '<checkfu-beta>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "archived_at": "<string>",
  "created_at": "<string>",
  "model": {
    "id": "<string>",
    "effort": {
      "type": "low"
    },
    "inference_geo": "global",
    "speed": "standard"
  },
  "name": "<string>",
  "description": "<string>",
  "mcp_servers": [
    {
      "type": "url",
      "name": "<string>",
      "url": "<string>"
    }
  ],
  "metadata": {},
  "multiagent": {
    "type": "coordinator",
    "agents": [
      {
        "type": "agent",
        "id": "<string>",
        "version": 1
      }
    ]
  },
  "skills": [
    {
      "type": "anthropic",
      "skill_id": "<string>",
      "version": "<string>"
    }
  ],
  "system": "<string>",
  "tools": [
    {
      "type": "agent_toolset_20260401",
      "configs": [
        {
          "name": "bash",
          "type": "bash",
          "enabled": true,
          "permission_policy": {
            "type": "always_allow"
          }
        }
      ],
      "default_config": {
        "enabled": true,
        "permission_policy": {
          "type": "always_allow"
        }
      }
    }
  ],
  "type": "agent",
  "updated_at": "<string>",
  "version": 1
}

{
  "error": {
    "type": "validation.malformed",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-malformed"
  }
}

{
  "error": {
    "type": "auth.invalid_key",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-invalid-key"
  }
}

{
  "error": {
    "type": "auth.disabled_tenancy",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
  }
}

{
  "error": {
    "type": "validation.not_found",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-not-found"
  }
}

{
  "error": {
    "type": "validation.conflict",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-conflict"
  }
}

{
  "error": {
    "type": "budget.exceeded",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#budget-exceeded"
  }
}

{
  "error": {
    "type": "runtime.internal",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#runtime-internal"
  }
}

Authorizations

Authorization

string

header

required

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

Headers

checkfu-version

enum<string>

required

Available options:

2026-08-24

checkfu-beta

string

required

idempotency-key

string

Maximum string length: 255

Path Parameters

agent_id

string

required

Pattern: ^agent_[0-9a-f]{32}$

Response

BetaManagedAgentsAgent

string

required

Pattern: ^agent_[0-9a-f]{32}$

archived_at

string | null

required

created_at

string

required

model

object

required

Show child attributes

name

string

required

Required string length: 1 - 255

description

string | null

required

mcp_servers

object[]

required

Show child attributes

metadata

object

required

at most 16 correlation pairs with keys of 1 to 64 characters

Show child attributes

multiagent

object | null

required

Show child attributes

skills

object[]

required

Option 1
Option 2

Show child attributes

system

string | null

required

tools

object[]

required

Option 1
Option 2
Option 3

Show child attributes

type

enum<string>

required

Available options:

agent

updated_at

string

required

version

integer

required

Required range: x > 0

Developer tools

Canonical tables

Author protocols

Generated HTTP API

Archive an Agent

Authorizations

Headers

Path Parameters

Response