Liking cljdoc? Tell your friends :D

anthropic.beta

Clojure wrappers over the beta agents-platform APIs of the official Anthropic Java SDK: skills, memory stores, agents, sessions, deployments, deployment runs, environments, vaults, user profiles, and webhooks.

These wrap beta endpoints that Anthropic may change; vault credentials, environment work, memory versions, thread events, session event streaming, session resources, agent versions, and detailed deployment-run trigger context/resources/schedules are not wrapped yet. Errors follow anthropic.core's contract: API/IO failures are ex-info keyed :anthropic/error with the SDK exception as cause.

Clojure wrappers over the beta agents-platform APIs of the official
Anthropic Java SDK: skills, memory stores, agents, sessions, deployments,
deployment runs, environments, vaults, user profiles, and webhooks.

These wrap beta endpoints that Anthropic may change; vault credentials,
environment work, memory versions, thread events, session event streaming,
session resources, agent versions, and detailed deployment-run trigger
context/resources/schedules are not wrapped yet. Errors follow
`anthropic.core`'s contract: API/IO failures are ex-info keyed
`:anthropic/error` with the SDK exception as cause.
raw docstring

archive-agentclj

(archive-agent client agent-id)

Archive an agent by id. Returns the archived agent map.

Archive an agent by id. Returns the archived agent map.
sourceraw docstring

archive-deploymentclj

(archive-deployment client deployment-id)

Archive a deployment by id. Returns the deployment map.

Archive a deployment by id. Returns the deployment map.
sourceraw docstring

archive-environmentclj

(archive-environment client environment-id)

Archive an environment by id. Returns the environment map.

Archive an environment by id. Returns the environment map.
sourceraw docstring

archive-memory-storeclj

(archive-memory-store client memory-store-id)

Archive a memory store by id. Returns the archived store map.

Archive a memory store by id. Returns the archived store map.
sourceraw docstring

archive-sessionclj

(archive-session client session-id)

Archive a session by id. Returns the archived session map.

Archive a session by id. Returns the archived session map.
sourceraw docstring

archive-session-threadclj

(archive-session-thread client session-id thread-id)

Archive a session thread by session id and thread id.

Archive a session thread by session id and thread id.
sourceraw docstring

archive-vaultclj

(archive-vault client vault-id)

Archive a vault by id. Returns the vault map.

Archive a vault by id. Returns the vault map.
sourceraw docstring

create-agentclj

(create-agent client req)

Create a managed agent: :name and :model (required), :system, :description, :metadata, :skills, :mcp-servers, and :tools. Returns the agent as a map (:id, :name, :model, :version, :system, :description, :skills, :mcp-servers, :tools, :created-at, :updated-at).

Create a managed agent: `:name` and `:model` (required), `:system`,
`:description`, `:metadata`, `:skills`, `:mcp-servers`, and `:tools`.
Returns the agent as a map (`:id`, `:name`, `:model`, `:version`,
`:system`, `:description`, `:skills`, `:mcp-servers`, `:tools`,
`:created-at`, `:updated-at`).
sourceraw docstring

create-deploymentclj

(create-deployment client req)

Create a deployment. Required: :name, :agent, :environment-id, and :initial-events (event maps). Optional: :description, :metadata, :vault-ids. Returns the deployment map.

Create a deployment. Required: `:name`, `:agent`, `:environment-id`, and
`:initial-events` (event maps). Optional: `:description`,
`:metadata`, `:vault-ids`. Returns the deployment map.
sourceraw docstring

create-enrollment-urlclj

(create-enrollment-url client user-profile-id)

Create an enrollment URL for a user profile. Returns {:url ... :expires-at ...}.

Create an enrollment URL for a user profile. Returns `{:url ...
:expires-at ...}`.
sourceraw docstring

create-environmentclj

(create-environment client req)

Create an environment: :name (required), :description, :metadata. Work/config/scope details are not wrapped yet. Returns the environment map.

Create an environment: `:name` (required), `:description`, `:metadata`.
Work/config/scope details are not wrapped yet. Returns the environment map.
sourceraw docstring

create-memoryclj

(create-memory client memory-store-id req)

Create a memory in memory-store-id: :path (required), :content, and :view. Returns the memory map.

Create a memory in `memory-store-id`: `:path` (required), `:content`,
and `:view`. Returns the memory map.
sourceraw docstring

create-memory-storeclj

(create-memory-store client req)

Create a memory store: :name (required), :description, :metadata. Returns the store as a map (:id, :name, :description, :created-at, :updated-at).

Create a memory store: `:name` (required), `:description`, `:metadata`.
Returns the store as a map (`:id`, `:name`, `:description`, `:created-at`,
`:updated-at`).
sourceraw docstring

create-sessionclj

(create-session client req)

Create a session for :agent (an agent id, required), with optional :title, :environment-id, and :metadata. Session resources, vault ids, and per-session agent overrides are not wrapped yet. Returns the session as a map (:id, :status, :title, :environment-id, :created-at, :updated-at).

Create a session for `:agent` (an agent id, required), with optional
`:title`, `:environment-id`, and `:metadata`. Session resources, vault
ids, and per-session agent overrides are not wrapped yet. Returns the
session as a map (`:id`, `:status`, `:title`, `:environment-id`,
`:created-at`, `:updated-at`).
sourceraw docstring

create-skillclj

(create-skill client req)

Create a skill from :files (paths or java.io.Files; typically a SKILL.md plus resources) with an optional :display-title. Returns the skill as a map (:id, :display-title, :latest-version, :source, :created-at, :updated-at).

Create a skill from `:files` (paths or `java.io.File`s; typically a
SKILL.md plus resources) with an optional `:display-title`. Returns the
skill as a map (`:id`, `:display-title`, `:latest-version`, `:source`,
`:created-at`, `:updated-at`).
sourceraw docstring

create-skill-versionclj

(create-skill-version client skill-id req)

Create a new skill version for skill-id from :files (paths or java.io.Files). Returns the version as a map.

Create a new skill version for `skill-id` from `:files` (paths or
`java.io.File`s). Returns the version as a map.
sourceraw docstring

create-user-profileclj

(create-user-profile client req)

Create a user profile with optional :name, :external-id, and :metadata. Relationship config is not wrapped yet. Returns the profile map.

Create a user profile with optional `:name`, `:external-id`, and
`:metadata`. Relationship config is not wrapped yet. Returns the profile
map.
sourceraw docstring

create-vaultclj

(create-vault client req)

Create a vault: :display-name (required), :metadata. Credentials are not wrapped yet. Returns the vault map.

Create a vault: `:display-name` (required), `:metadata`. Credentials are
not wrapped yet. Returns the vault map.
sourceraw docstring

delete-environmentclj

(delete-environment client environment-id)

Delete an environment by id. Returns {:id ... :deleted true}.

Delete an environment by id. Returns `{:id ... :deleted true}`.
sourceraw docstring

delete-memoryclj

(delete-memory client memory-store-id memory-id)
(delete-memory client memory-store-id memory-id opts)

Delete a memory. opts may include :expected-content-sha256.

Delete a memory. `opts` may include `:expected-content-sha256`.
sourceraw docstring

delete-memory-storeclj

(delete-memory-store client memory-store-id)

Delete a memory store by id. Returns {:id ... :deleted true}.

Delete a memory store by id. Returns `{:id ... :deleted true}`.
sourceraw docstring

delete-sessionclj

(delete-session client session-id)

Delete a session by id. Returns {:id ... :deleted true}.

Delete a session by id. Returns `{:id ... :deleted true}`.
sourceraw docstring

delete-skillclj

(delete-skill client skill-id)

Delete a skill by id. Returns {:id ... :deleted true}.

Delete a skill by id. Returns `{:id ... :deleted true}`.
sourceraw docstring

delete-skill-versionclj

(delete-skill-version client skill-id version)

Delete a skill version. Returns {:id ... :deleted true}.

Delete a skill version. Returns `{:id ... :deleted true}`.
sourceraw docstring

delete-vaultclj

(delete-vault client vault-id)

Delete a vault by id. Returns {:id ... :deleted true}.

Delete a vault by id. Returns `{:id ... :deleted true}`.
sourceraw docstring

download-skill-versionclj

(download-skill-version client skill-id version)

Download a skill version archive. Returns the response body as a byte array.

Download a skill version archive. Returns the response body as a byte array.
sourceraw docstring

get-agentclj

(get-agent client agent-id)

Retrieve an agent by id, as a map like create-agent's return.

Retrieve an agent by id, as a map like `create-agent`'s return.
sourceraw docstring

get-deploymentclj

(get-deployment client deployment-id)

Retrieve a deployment by id.

Retrieve a deployment by id.
sourceraw docstring

get-deployment-runclj

(get-deployment-run client deployment-run-id)

Retrieve a deployment run by id.

Retrieve a deployment run by id.
sourceraw docstring

get-environmentclj

(get-environment client environment-id)

Retrieve an environment by id.

Retrieve an environment by id.
sourceraw docstring

get-memoryclj

(get-memory client memory-store-id memory-id)

Retrieve a memory by id.

Retrieve a memory by id.
sourceraw docstring

get-memory-storeclj

(get-memory-store client memory-store-id)

Retrieve a memory store by id, as a map like create-memory-store's return.

Retrieve a memory store by id, as a map like `create-memory-store`'s return.
sourceraw docstring

get-sessionclj

(get-session client session-id)

Retrieve a session by id, as a map like create-session's return.

Retrieve a session by id, as a map like `create-session`'s return.
sourceraw docstring

get-session-threadclj

(get-session-thread client session-id thread-id)

Retrieve a session thread by session id and thread id.

Retrieve a session thread by session id and thread id.
sourceraw docstring

get-skillclj

(get-skill client skill-id)

Retrieve one skill by id, as a map shaped like create-skill's return.

Retrieve one skill by id, as a map shaped like `create-skill`'s return.
sourceraw docstring

get-skill-versionclj

(get-skill-version client skill-id version)

Retrieve one skill version.

Retrieve one skill version.
sourceraw docstring

get-user-profileclj

(get-user-profile client user-profile-id)

Retrieve a user profile by id.

Retrieve a user profile by id.
sourceraw docstring

get-vaultclj

(get-vault client vault-id)

Retrieve a vault by id.

Retrieve a vault by id.
sourceraw docstring

list-agentsclj

(list-agents client)

List agents (pages followed) as a vector of maps.

List agents (pages followed) as a vector of maps.
sourceraw docstring

list-deployment-runsclj

(list-deployment-runs client)

List deployment runs (pages followed) as a vector of maps.

List deployment runs (pages followed) as a vector of maps.
sourceraw docstring

list-deploymentsclj

(list-deployments client)

List deployments (pages followed) as a vector of maps.

List deployments (pages followed) as a vector of maps.
sourceraw docstring

list-environmentsclj

(list-environments client)

List environments (pages followed) as a vector of maps.

List environments (pages followed) as a vector of maps.
sourceraw docstring

list-memoriesclj

(list-memories client memory-store-id)
(list-memories client memory-store-id opts)

List memories (pages followed) for a memory store.

List memories (pages followed) for a memory store.
sourceraw docstring

list-memory-storesclj

(list-memory-stores client)

List memory stores (pages followed) as a vector of maps.

List memory stores (pages followed) as a vector of maps.
sourceraw docstring

list-session-eventsclj

(list-session-events client session-id)

List session events (pages followed) as normalized event maps.

List session events (pages followed) as normalized event maps.
sourceraw docstring

list-session-threadsclj

(list-session-threads client session-id)

List session threads (pages followed) for a session.

List session threads (pages followed) for a session.
sourceraw docstring

list-sessionsclj

(list-sessions client)

List sessions (pages followed) as a vector of maps.

List sessions (pages followed) as a vector of maps.
sourceraw docstring

list-skill-versionsclj

(list-skill-versions client skill-id)

List skill versions (pages followed) as a vector of maps.

List skill versions (pages followed) as a vector of maps.
sourceraw docstring

list-skillsclj

(list-skills client)

List skills (pages followed) as a vector of maps like get-skill.

List skills (pages followed) as a vector of maps like `get-skill`.
sourceraw docstring

list-user-profilesclj

(list-user-profiles client)

List user profiles (pages followed) as a vector of maps.

List user profiles (pages followed) as a vector of maps.
sourceraw docstring

list-vaultsclj

(list-vaults client)

List vaults (pages followed) as a vector of maps.

List vaults (pages followed) as a vector of maps.
sourceraw docstring

pause-deploymentclj

(pause-deployment client deployment-id)

Pause a deployment by id. Returns the deployment map.

Pause a deployment by id. Returns the deployment map.
sourceraw docstring

run-deploymentclj

(run-deployment client deployment-id)

Run a deployment manually by id. Returns the deployment run map.

Run a deployment manually by id. Returns the deployment run map.
sourceraw docstring

send-session-eventsclj

(send-session-events client session-id events)

Send a vector of session event maps to session-id. Event maps support {:type :user-message :content ...}, {:type :system-message :content ...}, and {:type :user-define-outcome :description ... :rubric ...}.

Send a vector of session event maps to `session-id`. Event maps support
`{:type :user-message :content ...}`, `{:type :system-message :content ...}`,
and `{:type :user-define-outcome :description ... :rubric ...}`.
sourceraw docstring

unpause-deploymentclj

(unpause-deployment client deployment-id)

Unpause a deployment by id. Returns the deployment map.

Unpause a deployment by id. Returns the deployment map.
sourceraw docstring

unwrap-webhookclj

(unwrap-webhook client payload)
(unwrap-webhook client payload opts)

Parse a raw webhook payload into a normalized map. With a second arity, verifies signatures when :headers and :secret are supplied.

Parse a raw webhook payload into a normalized map. With a second arity,
verifies signatures when `:headers` and `:secret` are supplied.
sourceraw docstring

update-agentclj

(update-agent client agent-id changes)

Update an agent. changes requires :version (the current agent version, for optimistic concurrency - see :version in get-agent's return) plus any of :name, :model, :system, :description, :metadata. Returns the updated agent map.

Update an agent. `changes` requires `:version` (the current agent version,
for optimistic concurrency - see `:version` in `get-agent`'s return) plus
any of `:name`, `:model`, `:system`, `:description`, `:metadata`. Returns
the updated agent map.
sourceraw docstring

update-deploymentclj

(update-deployment client deployment-id changes)

Update a deployment. changes may include :name, :agent, :environment-id, :initial-events, :description, :metadata, or :vault-ids. Returns the updated deployment map.

Update a deployment. `changes` may include `:name`, `:agent`,
`:environment-id`, `:initial-events`, `:description`, `:metadata`, or
`:vault-ids`. Returns the updated deployment map.
sourceraw docstring

update-environmentclj

(update-environment client environment-id changes)

Update an environment's :name, :description, or :metadata.

Update an environment's `:name`, `:description`, or `:metadata`.
sourceraw docstring

update-memoryclj

(update-memory client memory-store-id memory-id changes)

Update a memory's :path, :content, or :view.

Update a memory's `:path`, `:content`, or `:view`.
sourceraw docstring

update-memory-storeclj

(update-memory-store client memory-store-id changes)

Update a memory store's :name, :description, or :metadata. Returns the updated store map.

Update a memory store's `:name`, `:description`, or `:metadata`. Returns
the updated store map.
sourceraw docstring

update-sessionclj

(update-session client session-id changes)

Update a session's :title or :metadata. Returns the updated session map.

Update a session's `:title` or `:metadata`. Returns the updated session map.
sourceraw docstring

update-user-profileclj

(update-user-profile client user-profile-id changes)

Update a user profile's :name, :external-id, or :metadata.

Update a user profile's `:name`, `:external-id`, or `:metadata`.
sourceraw docstring

update-vaultclj

(update-vault client vault-id changes)

Update a vault's :display-name or :metadata.

Update a vault's `:display-name` or `:metadata`.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close