> ## Documentation Index
> Fetch the complete documentation index at: https://cadenya.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Archive a widget
> Take a widget offline without losing its hostname. Sessions are revoked; the label waits for unarchive.
The pause button. Archiving moves a [widget](/docs/api-reference/widgetservice/create-a-new-widget) to `STATE_ARCHIVED`: the hostname stops serving at the edge, existing sessions are revoked, and no new sessions can be minted. Unlike [delete](/docs/api-reference/widgetservice/delete-a-widget), the DNS label stays reserved for this widget.
```typescript TypeScript theme={null}
await client.widgets.archive(widgetId, { workspaceId });
// state: 'STATE_ARCHIVED'
```
```go Go theme={null}
// state: STATE_ARCHIVED
_, err := client.Widgets.Archive(ctx, widgetID,
cadenya.WidgetArchiveParams{WorkspaceID: cadenya.String(workspaceID)})
if err != nil {
panic(err.Error())
}
```
```ruby Ruby theme={null}
cadenya.widgets.archive(widget_id, workspace_id: workspace_id)
# state: STATE_ARCHIVED
```
```bash cURL theme={null}
curl -X POST "https://api.cadenya.com/v1/workspaces/${WORKSPACE_ID}/widgets/${WIDGET_ID}:archive" \
-H "Authorization: Bearer ${CADENYA_API_KEY}" \
-H "Content-Type: application/json" \
-d '{}'
```
## What archive touches
```
hostname → stops serving at the edge
sessions → revoked, terminally
new sessions → mint attempts fail
DNS label → kept, comes back on unarchive
conversations → untouched, still queryable
```
The session revocation is the part to plan around: it is the same terminal revocation as [revoke](/docs/api-reference/widgetsessionservice/revoke-a-widget-session), and unarchiving does not resurrect the sessions. Visitors get fresh sessions when your backend mints them.
## Related
Same hostname, back in service.
The permanent version. The label never returns.
What visitors need again after unarchive.
Archived widgets stay visible in the list.
## OpenAPI
````yaml post /v1/workspaces/{workspaceId}/widgets/{id}:archive
openapi: 3.1.0
info:
title: Cadenya API
description: API for the Cadenya Agent Runtime platform.
version: '1.0'
servers:
- url: https://api.cadenya.com
description: Production server
security:
- bearerAuth: []
tags:
- name: AIProviderKeyService
- name: APIKeyService
description: |-
Issue, rotate, disable, and revoke a workspace's API keys. Every key
belongs to exactly one workspace; the system-managed global account key is
managed via GlobalAPIKeyService instead.
- name: AccountService
description: >-
Manage the authenticated account. Accounts are the top-level
organizational
unit and contain one or more workspaces.
- name: AgentScheduleService
description: >-
Manage recurring schedules attached to agents. Schedules trigger
objectives
on a cadence defined by AgentScheduleSpec.Schedule.
- name: AgentService
description: >-
Manage AI agents within a workspace. Agents define AI behavior and tool
access.
- name: AgentVariationService
description: >-
Manage variations of an agent and their tool, sub-agent, and memory layer
assignments.
- name: GlobalAPIKeyService
description: |-
Manage the account's system-provisioned global API key. The global key is
the only key that spans every workspace; it is created by the system and
cannot be deleted, so the surface is retrieve, rotate, and the
disable/enable kill switch.
- name: MemoryService
description: >-
Manage memory layers and their entries. Layers are named containers that
can
be composed into an objective's memory cascade; entries are the keyed values
within a layer. System-managed layers (e.g., episodic layers created by the
runtime) cannot be mutated through this API.
- name: ModelService
description: |-
Manage LLM models available to a workspace. Models represent provider and
family pairs (e.g., "anthropic/claude-sonnet-4.6"). Workspaces are seeded
with the supported models and you can enable or disable each one.
- name: ObjectiveEventStreamsService
- name: ObjectiveService
- name: ProfilesService
description: |-
Operations on profiles, the account-level principals (users, API keys,
system) that authenticate against the API.
- name: SearchService
- name: TenantService
description: >-
Read and erase tenants and the subjects under them. Tenants and subjects
are
created by assertion — on objective creation or widget session mint — never
directly, so this service has no create or update: it exists to enumerate what
assertions have produced, and to destroy it on request.
- name: ToolService
description: >-
Manage tool sets and the tools they contain. Tool sets group related
tools,
and tools define specific capabilities available to agents.
When a tool set is managed, only API key actors can modify its tools; human
(profile) actors cannot.
- name: UploadService
description: |-
Issue short-lived presigned URLs for direct client-to-object-storage
uploads. Created uploads can be referenced by id when creating or updating
resources that accept binary content (e.g., MemoryEntry).
- name: WidgetService
description: |-
Manage embeddable chat widgets. A widget binds an agent to a globally
unique hostname with a per-widget origin allowlist; browsers reach it with
session tokens minted via WidgetSessionService.
- name: WidgetSessionService
description: >-
Mint and manage widget sessions. Session creation is server-to-server
only:
the customer's backend authenticates its visitor, asserts tenant/subject
context, attaches any per-visitor secrets, and receives a short-lived
bearer token the browser uses against the widget host.
- name: WorkspaceAdminService
description: >-
Administer workspaces across the account: create and archive workspaces
and
manage their membership. These operations are account-scoped and require the
admin role (a token whose profile holds the WorkOS admin role); they live
under /v1/account/workspaces rather than the workspace-scoped /v1/workspaces
tree so an admin can manage any workspace in the account, including ones they
are not themselves a member of.
- name: WorkspaceSecretService
- name: WorkspaceService
description: |-
Manage workspaces within an account. Workspaces provide organizational
grouping and isolation for resources such as agents, tools, and API keys.
This is the workspace-scoped, end-user surface. Administrative operations
(create / archive workspaces, manage members) live in WorkspaceAdminService
under /v1/account/workspaces and require the admin role.
paths:
/v1/workspaces/{workspaceId}/widgets/{id}:archive:
post:
tags:
- WidgetService
- Widgets
summary: Archive a widget
description: >-
Transitions a widget to STATE_ARCHIVED. The hostname stops serving at
the edge, existing sessions are revoked, and no new sessions can be
minted. Reversible via :unarchive.
operationId: WidgetService_ArchiveWidget
parameters:
- name: workspaceId
in: path
description: Workspace ID.
required: true
schema:
type: string
example: workspace_01HXKD2E5NQM3T9AYWCF133E3Q
- name: id
in: path
description: >-
Widget ID. Accepts the canonical `wgt_…` form or the
`external_id:` form.
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ArchiveWidgetRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Widget'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
x-codeSamples:
- lang: JavaScript
source: |-
import Cadenya from '@cadenya/cadenya';
const client = new Cadenya({
apiKey: process.env['CADENYA_API_KEY'], // This is the default and can be omitted
});
const widget = await client.widgets.archive('id', {
workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q',
});
console.log(widget.metadata);
- lang: Python
source: |-
import os
from cadenya import Cadenya
client = Cadenya(
api_key=os.environ.get("CADENYA_API_KEY"), # This is the default and can be omitted
)
widget = client.widgets.archive(
id="id",
workspace_id="workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
)
print(widget.metadata)
- lang: Go
source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"go.cadenya.com/cadenya-go\"\n\t\"go.cadenya.com/cadenya-go/option\"\n)\n\nfunc main() {\n\tclient := cadenya.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\twidget, err := client.Widgets.Archive(\n\t\tcontext.TODO(),\n\t\t\"id\",\n\t\tcadenya.WidgetArchiveParams{\n\t\t\tWorkspaceID: cadenya.String(\"workspace_01HXKD2E5NQM3T9AYWCF133E3Q\"),\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", widget.Metadata)\n}\n"
- lang: Ruby
source: >-
require "cadenya"
cadenya = Cadenya::Client.new(api_key: "My API Key")
widget = cadenya.widgets.archive("id", workspace_id:
"workspace_01HXKD2E5NQM3T9AYWCF133E3Q")
puts(widget)
- lang: CLI
source: |-
cadenya widgets archive \
--api-key 'My API Key' \
--workspace-id workspace_01HXKD2E5NQM3T9AYWCF133E3Q \
--id id
components:
schemas:
ArchiveWidgetRequest:
type: object
properties:
workspaceId:
readOnly: true
example: workspace_01HXKD2E5NQM3T9AYWCF133E3Q
type: string
description: Workspace ID.
id:
readOnly: true
example: wgt_01HXKD2E5NQM3T9AYWCFMZZZBD
type: string
description: >-
Widget ID. Accepts the canonical `wgt_…` form or the
`external_id:` form.
description: Archive widget request.
Widget:
required:
- metadata
- spec
- state
type: object
properties:
metadata:
$ref: '#/components/schemas/ResourceMetadata'
spec:
$ref: '#/components/schemas/WidgetSpec'
info:
$ref: '#/components/schemas/WidgetInfo'
state:
readOnly: true
enum:
- STATE_UNSPECIFIED
- STATE_ACTIVE
- STATE_ARCHIVED
type: string
description: |-
The current lifecycle state of the widget. Output only. Widgets are
created STATE_ACTIVE; use the :archive and :unarchive actions to
transition between states.
format: enum
description: >-
Widget is an embeddable chat surface bound to a single agent. Each
widget
owns a globally unique, immutable DNS label under the widgets domain
(e.g. "k7m2xq9fp4wn.widgets.cadenya.com"): one widget = one hostname = one
origin allowlist = one agent binding. Browsers talk to the widget host with
session bearer tokens minted server-side via WidgetSessionService.
Status:
type: object
properties:
code:
type: integer
description: >-
The status code, which should be an enum value of
[google.rpc.Code][google.rpc.Code].
format: int32
message:
type: string
description: >-
A developer-facing error message, which should be in English. Any
user-facing error message should be localized and sent in the
[google.rpc.Status.details][google.rpc.Status.details] field, or
localized by the client.
details:
type: array
items:
$ref: '#/components/schemas/GoogleProtobufAny'
description: >-
A list of messages that carry the error details. There is a common
set of message types for APIs to use.
description: >-
The `Status` type defines a logical error model that is suitable for
different programming environments, including REST APIs and RPC APIs. It
is used by [gRPC](https://github.com/grpc). Each `Status` message
contains three pieces of data: error code, error message, and error
details. You can find out more about this error model and how to work
with it in the [API Design
Guide](https://cloud.google.com/apis/design/errors).
ResourceMetadata:
required:
- id
- accountId
- workspaceId
- name
- profileId
- createdAt
type: object
properties:
id:
readOnly: true
type: string
description: >-
Unique identifier for the resource (prefixed ULID, e.g.,
"agent_01HXK...")
accountId:
readOnly: true
example: account_01HXKD2E5NQM3T9AYWCFTJHJVF
type: string
description: >-
Account this resource belongs to for multi-tenant isolation
(prefixed ULID)
workspaceId:
readOnly: true
example: workspace_01HXKD2E5NQM3T9AYWCF133E3Q
type: string
description: >-
Workspace this resource belongs to for organizational grouping
(prefixed ULID)
name:
type: string
description: >-
Human-readable name for the resource (e.g., "Customer Support
Agent", "Email Tool")
Required for resources that users interact with directly
externalId:
type: string
description: >-
External ID for the resource (e.g., a workflow ID from an external
system)
labels:
type: object
additionalProperties:
type: string
description: |-
Key-value pairs for categorization and filtering. Values are 0-63
alphanumeric characters with "-", "_", or "." allowed between; keys
follow the same shape and additionally accept an optional DNS-subdomain
prefix (e.g. "cadenya.com/") of at most 253 characters.
Examples: {"environment": "production", "team": "platform", "version": "v2"}
profileId:
readOnly: true
example: profile_01HXKD2E5NQM3T9AYWCFS0AP08
type: string
description: ID of the actor (user or service account) that created this resource
createdAt:
readOnly: true
type: string
description: Timestamp when this resource was created
format: date-time
updatedAt:
readOnly: true
type: string
description: Timestamp when this resource was last updated
format: date-time
description: >-
Standard metadata for persistent, named resources (e.g., agents, tools,
prompts)
WidgetSpec:
required:
- agentId
type: object
properties:
agentId:
example: agent_01HXKD2E5NQM3T9AYWCFMGWT9Y
type: string
description: >-
Agent this widget is bound to. Accepts the canonical `agent_…` form
or the
`external_id:` form. Sessions copy the agent at mint: re-pointing a
widget's agent affects new sessions only.
variationId:
example: agentvar_01HXKD2E5NQM3T9AYWCF32BSPP
type: string
description: >-
Optional explicit variation pin. Must belong to the widget's agent.
When
set, every objective created through the widget runs this variation —
bypassing the agent's variation_selection_mode (staged rollout: pin in
production, follow in staging, promote by clearing). When unset, the
agent's selection mode chooses per conversation.
originAllowlist:
type: array
items:
type: string
description: >-
Web origins allowed to embed and use this widget, enforced at the
edge on
every browser request. Exact origins only (scheme + host + optional
port), no paths, no wildcard subdomains.
description: WidgetSpec is the user-provided configuration for a widget.
WidgetInfo:
type: object
properties:
dnsLabel:
readOnly: true
example: k7m2xq9fp4wn
type: string
description: |-
The widget's DNS label — the single hostname label under the widgets
domain. Server-generated at creation, globally unique, immutable, and
deliberately unrelated to the widget's id.
host:
readOnly: true
example: k7m2xq9fp4wn.widgets.cadenya.com
type: string
description: >-
The full hostname browsers talk to. Authoritative — clients must use
this
value rather than constructing the hostname themselves.
agent:
readOnly: true
allOf:
- $ref: '#/components/schemas/BareMetadata'
description: The agent this widget is bound to.
createdBy:
$ref: '#/components/schemas/Profile'
description: WidgetInfo provides read-only server-derived data about a widget.
GoogleProtobufAny:
type: object
properties:
'@type':
type: string
description: The type of the serialized message.
additionalProperties: true
description: >-
Contains an arbitrary serialized message along with a @type that
describes the type of the serialized message.
BareMetadata:
type: object
properties:
id:
readOnly: true
type: string
name:
readOnly: true
type: string
description: >-
Human-readable name of the referenced resource, populated by the
server
on reads for convenience. Absent on references to resources that do not
have a name (e.g., objective tasks).
description: |-
BareMetadata contains the minimal metadata for a resource: the ID and an
optional human-readable name. These are used for reference fields where the
full metadata (account scoping, timestamps, labels, external IDs) is not
needed — e.g., the tool references inside an agent variation spec or the
tools assigned to an objective. Both fields are server-populated; clients
provide IDs through sibling fields rather than by constructing a
BareMetadata themselves.
Profile:
required:
- metadata
- spec
type: object
properties:
metadata:
$ref: '#/components/schemas/AccountResourceMetadata'
spec:
$ref: '#/components/schemas/ProfileSpec'
description: |-
A profile identifies a user or non-human principal (such as an API key)
at the account level. Profiles are account-scoped and can be granted access
to multiple workspaces.
AccountResourceMetadata:
required:
- id
- accountId
- name
- profileId
type: object
properties:
id:
readOnly: true
type: string
description: >-
Unique identifier for the resource (prefixed ULID, e.g.,
"apikey_01HXK...")
accountId:
readOnly: true
example: account_01HXKD2E5NQM3T9AYWCFTJHJVF
type: string
description: >-
Account this resource belongs to for multi-tenant isolation
(prefixed ULID)
name:
type: string
description: >-
Human-readable name for the resource (e.g., "Customer Support
Agent", "Email Tool")
Required for resources that users interact with directly
externalId:
type: string
description: >-
External ID for the resource (e.g., a workflow ID from an external
system)
labels:
type: object
additionalProperties:
type: string
description: |-
Key-value pairs for categorization and filtering. Values are 0-63
alphanumeric characters with "-", "_", or "." allowed between; keys
follow the same shape and additionally accept an optional DNS-subdomain
prefix (e.g. "cadenya.com/") of at most 253 characters.
Examples: {"environment": "production", "team": "platform", "version": "v2"}
profileId:
readOnly: true
example: profile_01HXKD2E5NQM3T9AYWCFS0AP08
type: string
createdAt:
readOnly: true
type: string
format: date-time
description: >-
AccountResourceMetadata is used to represent a resource that is
associated to an account but not to a workspace.
ProfileSpec:
required:
- type
type: object
properties:
email:
type: string
description: >-
Email address of the profile. Required and unique within an account
for
user profiles.
name:
type: string
description: Display name (e.g., "Bobby Tables").
type:
enum:
- PROFILE_TYPE_UNSPECIFIED
- PROFILE_TYPE_USER
- PROFILE_TYPE_API_KEY
- PROFILE_TYPE_SYSTEM
type: string
description: >-
Whether this profile represents a human user, an API key, or a
system
principal.
format: enum
description: Configuration for a profile.
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
````