> This page is for Workspace app.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.cloudraker.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.cloudraker.com/_mcp/server.

# Unarchive an agent

POST https://api.cloudraker.com/agents/{agentRef}/unarchive

Clears `archivedAt` and puts the published version back in service, so directory visibility and runnability agree again. The agent keeps its handle and its version history. Authorization: organization administrators only. A `private` agent is visible only to its owner; every other caller gets 404. Response: `{ data: Agent }`.

Reference: https://docs.cloudraker.com/workspace/api/workspace-agents/unarchive-paperwork-agent

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `agentRef` (string, required)

## Response

### 200

The unarchived agent.

- `data` (Agent, required)

## Errors

### 404 Not Found Error

`not_found` — no such agent in this organization.

- `any`

## Types

### Agent

- `id` (string, required)
- `handle` (string, required) — Unique per org, derived from the name when not given (`mike`, `mike-2`, …).
- `name` (string, required)
- `role` (string, required)
- `avatar` (AgentAvatar, required)
- `visibility` (enum, required)
  - Allowed values: `org`, `private`
- `ownerUserId` (string, required)
- `publishedVersionId` (string, required, nullable) — The `agv_` id a run is started with. Null until the agent is published.
- `draftVersionId` (string, required)
- `emailTriggerId` (string, required, nullable)
- `sourcePlaybookId` (string, required, nullable) — Set on agents created by the playbook migration; null otherwise.
- `createdAt` (datetime, required)
- `updatedAt` (datetime, required)
- `createdBy` (string, required)
- `archivedAt` (datetime, required, nullable)
- `documentAgent` (boolean, optional)

### AgentAvatar

- `kind` (enum, required)
  - Allowed values: `initials`, `generated`
- `color` (string, optional)

## Examples

**Response**

```json
{
  "data": {
    "id": "string",
    "handle": "string",
    "name": "string",
    "role": "string",
    "avatar": {
      "kind": "initials",
      "color": "string"
    },
    "visibility": "org",
    "ownerUserId": "string",
    "publishedVersionId": "string",
    "draftVersionId": "string",
    "emailTriggerId": "string",
    "sourcePlaybookId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "createdBy": "string",
    "archivedAt": "2024-01-15T09:30:00Z",
    "documentAgent": true
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.cloudraker.com/agents/agentRef/unarchive"

headers = {"Authorization": "Bearer <token>"}

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

print(response.json())
```

```javascript
const url = 'https://api.cloudraker.com/agents/agentRef/unarchive';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "https://api.cloudraker.com/agents/agentRef/unarchive"

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

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.cloudraker.com/agents/agentRef/unarchive")

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

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

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.cloudraker.com/agents/agentRef/unarchive")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.cloudraker.com/agents/agentRef/unarchive', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.cloudraker.com/agents/agentRef/unarchive");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.cloudraker.com/agents/agentRef/unarchive")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```