> ## 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.
# Get an agent
> The agent's shell: its name, mode, and state. The real configuration lives in its variations.
An agent is the role. This returns the role's outline, not its substance: the substance lives in the [variations](/docs/api-reference/agentvariationservice/list-variations), which you read separately.
```typescript TypeScript theme={null}
const agent = await client.agents.retrieve(agentId, { workspaceId });
console.log(agent.state); // 'STATE_PUBLISHED'
console.log(agent.spec.variationSelectionMode); // 'VARIATION_SELECTION_MODE_RANDOM'
console.log(agent.info.variationCount); // 1
```
```go Go theme={null}
agent, err := client.Agents.Get(ctx, agentID, cadenya.AgentGetParams{
WorkspaceID: cadenya.String(workspaceID),
})
if err != nil {
log.Fatal(err)
}
log.Println(agent.State) // STATE_PUBLISHED
log.Println(agent.Spec.VariationSelectionMode) // VARIATION_SELECTION_MODE_RANDOM
log.Println(agent.Info.VariationCount) // 1
```
```ruby Ruby theme={null}
agent = cadenya.agents.retrieve(agent_id, workspace_id: workspace_id)
puts agent.state # STATE_PUBLISHED
puts agent.spec.variation_selection_mode # VARIATION_SELECTION_MODE_RANDOM
puts agent.info.variation_count # 1
```
```bash cURL theme={null}
curl "https://api.cadenya.com/v1/workspaces/${WORKSPACE_ID}/agents/${AGENT_ID}" \
-H "Authorization: Bearer ${CADENYA_API_KEY}"
```
## What the shell holds
`spec` is short by design: `description`, `variationSelectionMode`, `enableEpisodicMemory`, and `outputDefinition` when the agent has one. No prompt, no model, no tools. Those are per-variation, because an agent runs several variations and lets the strong one win.
`info` carries `variationCount` and `createdBy`, and it returns on every read: `includeInfo` is a no-op here, as on the other agent-family reads. So one call tells you the agent exists, whether it can run (`state`), how it picks a variation, and how many it has to pick from.
## The three states
| State | Can it run? |
| ----------------- | -------------------------------------- |
| `STATE_DRAFT` | No. Objectives against it are a `400`. |
| `STATE_PUBLISHED` | Yes. |
| `STATE_ARCHIVED` | No. Retired, history kept. |
`state` is the field to check before you create an objective. A [draft](/docs/api-reference/agentservice/publish-an-agent) agent, or one you archived, refuses new work. See [publish](/docs/api-reference/agentservice/publish-an-agent) for the lifecycle.
## Fetch by your own ID
Agents take an [external ID](/docs/guides/use-your-own-ids), so a `support-bot` slug from your system fetches the agent without you storing a Cadenya ID:
```typescript theme={null}
const agent = await client.agents.retrieve('external_id:support-bot', { workspaceId });
```
A missing ID, in either form, is a `404`.
## Related
The real configuration, and the `score` that ranks them.
What moves `state` from `DRAFT` to `PUBLISHED`.
`variationSelectionMode`, `outputDefinition`, and episodic memory.
What a published agent can finally do.
## OpenAPI
````yaml get /v1/workspaces/{workspaceId}/agents/{id}
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}/agents/{id}:
get:
tags:
- AgentService
- Agents
summary: Get an agent by ID
description: Retrieves an agent by ID from the workspace
operationId: AgentService_GetAgent
parameters:
- name: workspaceId
in: path
description: Workspace ID.
required: true
schema:
type: string
example: workspace_01HXKD2E5NQM3T9AYWCF133E3Q
- name: id
in: path
description: >-
Agent ID. Accepts the canonical `agent_…` form or the
`external_id:` form.
required: true
schema:
example: agent_01HXKD2E5NQM3T9AYWCFMGWT9Y
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Agent'
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 agent = await
client.agents.retrieve('agent_01HXKD2E5NQM3T9AYWCFMGWT9Y', {
workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q',
});
console.log(agent.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
)
agent = client.agents.retrieve(
id="agent_01HXKD2E5NQM3T9AYWCFMGWT9Y",
workspace_id="workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
)
print(agent.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\tagent, err := client.Agents.Get(\n\t\tcontext.TODO(),\n\t\t\"agent_01HXKD2E5NQM3T9AYWCFMGWT9Y\",\n\t\tcadenya.AgentGetParams{\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\", agent.Metadata)\n}\n"
- lang: Ruby
source: |-
require "cadenya"
cadenya = Cadenya::Client.new(api_key: "My API Key")
agent = cadenya.agents.retrieve(
"agent_01HXKD2E5NQM3T9AYWCFMGWT9Y",
workspace_id: "workspace_01HXKD2E5NQM3T9AYWCF133E3Q"
)
puts(agent)
- lang: CLI
source: |-
cadenya agents retrieve \
--api-key 'My API Key' \
--workspace-id workspace_01HXKD2E5NQM3T9AYWCF133E3Q \
--id agent_01HXKD2E5NQM3T9AYWCFMGWT9Y
components:
schemas:
Agent:
required:
- metadata
- spec
- state
type: object
properties:
metadata:
allOf:
- $ref: '#/components/schemas/ResourceMetadata'
description: Resource metadata
spec:
allOf:
- $ref: '#/components/schemas/AgentSpec'
description: Agent specification
info:
readOnly: true
allOf:
- $ref: '#/components/schemas/AgentInfo'
description: Agent information
state:
readOnly: true
enum:
- STATE_UNSPECIFIED
- STATE_DRAFT
- STATE_PUBLISHED
- STATE_ARCHIVED
type: string
description: >-
The current lifecycle state of the agent. Output only. Agents are
created
in STATE_DRAFT; use the :publish, :unpublish, :archive, and :unarchive
actions to transition between states.
format: enum
description: Agent resource
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)
AgentSpec:
required:
- variationSelectionMode
type: object
properties:
description:
type: string
description: Description of the agent's purpose
webhookEventsUrl:
type: string
description: >-
The URL that Cadenya will send events for any objective assigned to
the agent.
variationSelectionMode:
enum:
- VARIATION_SELECTION_MODE_UNSPECIFIED
- VARIATION_SELECTION_MODE_RANDOM
- VARIATION_SELECTION_MODE_WEIGHTED
type: string
description: >-
Controls how variations are automatically selected when creating
objectives
Defaults to RANDOM when unspecified
format: enum
systemPromptDataSchema:
type: object
additionalProperties: true
description: >-
SystemPromptDataSchema enforces the shape of system_prompt_data when
objectives are created. This is valuable when using liquid
formatting in agent
variation system prompt templates. The schema is also used when the agent is attached as a sub-agent, as it becomes the tool's input parameter schema.
If omitted, the sub-agent schema will be loaded with a simple "prompt" free text string as its schema.
outputDefinition:
type: object
additionalProperties: true
description: |-
Optional output definition for objectives created for this agent.
When provided, Cadenya will append a tool to that will be called by the LLM in use by the variant to extract information in the format provided here.
Use this option when you want structured data to be created by your objectives.
enableEpisodicMemory:
type: boolean
description: |-
Enable episodic memory for objectives created for this agent.
When true, objective creation requires an episodic_memory key and the
system finds or creates a memory layer for that (agent, key) pair, letting
the agent store and retrieve memories across objectives that share the key.
Memory is agent-level so all variations of the agent share the same layers.
episodicMemoryTtl:
pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$
type: integer
description: |-
How long episodic memories should be retained.
Each new objective slides the layer's expiry forward by this duration, and
stored entries expire this long after they are written.
If not set, episodic memories are retained indefinitely.
description: Agent specification (user-provided configuration)
AgentInfo:
type: object
properties:
variationCount:
readOnly: true
type: integer
format: int32
createdBy:
$ref: '#/components/schemas/Profile'
description: >-
AgentInfo contains simple information about an agent for display or
quick reference
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.
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
````