Archive an agent role

POST

/agent-roles/{id}/archive

const url = 'https://your-org.evershell.ai/v1/agent-roles/example/archive';
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);
}

curl --request POST \
  --url https://your-org.evershell.ai/v1/agent-roles/example/archive \
  --header 'Authorization: Bearer <token>'

Permissions: caps:write.

Hides the role from default listings. Existing workspaces keep running with their previously-activated config.

Authorizations

bearerAuth

Parameters

Path Parameters

required

string

Responses

200

application/json

object

status

string

Example

{
  "status": "archived"
}

404

Resource not found in the caller’s org

application/json

object

error

required

object

code

required

Closed-enum slug (e.g. permission_denied, validation_error, workspace_not_found)

string

message

required

Human-readable summary

string

request_id

required

Server-generated request id for correlating logs

string

details

Optional structured context. Validation errors land at details.fields as a per-field map.

object

key

additional properties

any

Example

{
  "error": {
    "code": "permission_denied",
    "message": "caller lacks required scope",
    "request_id": "7f3a9c2e"
  }
}

409

workspaces_active — workspaces using this role are still running. Stop them (or call POST /agent-roles/{id}/stop-workspaces) first.

application/json

object

error

required

object

code

required

Closed-enum slug (e.g. permission_denied, validation_error, workspace_not_found)

string

message

required

Human-readable summary

string

request_id

required

Server-generated request id for correlating logs

string

details

Optional structured context. Validation errors land at details.fields as a per-field map.

object

key

additional properties

any

Example

{
  "error": {
    "code": "permission_denied",
    "message": "caller lacks required scope",
    "request_id": "7f3a9c2e"
  }
}