Documentation Index
Fetch the complete documentation index at: https://docs.qoder.com/llms.txt
Use this file to discover all available pages before exploring further.
POST /v1/agents/{agent_id}/archive
Archives the specified Agent. Archived Agents are hidden from the default list but remain retrievable by ID.
| Header | Required | Description |
|---|
Authorization | Yes | Bearer <PAT> |
Path parameters
| Parameter | Type | Required | Description |
|---|
agent_id | string | Yes | Agent unique identifier |
Request body
No request body.
Example request
curl -X POST "https://api.qoder.com/api/v1/cloud/agents/agent_019eXXXX.../archive" \
-H "Authorization: Bearer $QODER_PAT"
Example response
HTTP 200 OK
{
"type": "agent",
"id": "agent_019eXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"name": "doc-test-agent-updated",
"description": "Used for API documentation testing",
"model": "ultimate",
"system": "You are an updated documentation testing assistant.",
"instructions": "You are an updated documentation testing assistant.",
"tools": [],
"mcp_servers": [],
"default_environment": "",
"version": 2,
"created_at": "2026-05-18T15:26:39.61669Z",
"updated_at": "2026-05-18T15:27:22.698411Z"
}
Response fields
Returns the full Agent object after archival. updated_at reflects the time of the archive operation.
| Field | Type | Description |
|---|
type | string | Always "agent" |
id | string | Agent unique identifier |
name | string | Agent name |
description | string | Agent description |
model | string | Model identifier |
instructions | string | System prompt |
system | string | Alias of instructions (deprecated, use instructions instead) |
tools | array | Tool configuration list |
mcp_servers | array | MCP server configuration |
default_environment | string | Default runtime environment |
version | integer | Current version |
created_at | string | Creation time (ISO 8601) |
updated_at | string | Last update time (ISO 8601), refreshed on archive |
Errors
| HTTP | Type | Trigger |
|---|
| 401 | authentication_error | PAT invalid or expired |
| 403 | permission_error | Not authorized to archive this Agent |
| 404 | not_found_error | Agent with the given ID does not exist |
Archive vs. delete
| Action | Effect | Recoverable |
|---|
| Archive | Hides the Agent from default listings; data is retained | Yes (can be unarchived) |
| Delete | Permanently removes the Agent | No |
Notes
- Archive is a soft-delete; Agent data is retained.
- Archived Agents are excluded from the default list returned by
GET /v1/agents.
- They remain retrievable via
GET /v1/agents/{agent_id}.
- The operation is idempotent; archiving an already-archived Agent does not raise an error.
