91 lines
2.8 KiB
Markdown
91 lines
2.8 KiB
Markdown
---
|
|
display_name: AgentAPI
|
|
description: Building block for modules that need to run an AgentAPI server
|
|
icon: ../../../../.icons/coder.svg
|
|
verified: true
|
|
tags: [internal, library]
|
|
---
|
|
|
|
# AgentAPI
|
|
|
|
> [!CAUTION]
|
|
> We do not recommend using this module directly. Instead, please consider using one of our [Tasks-compatible AI agent modules](https://registry.coder.com/modules?search=tag%3Atasks).
|
|
|
|
The AgentAPI module is a building block for modules that need to run an AgentAPI server. It is intended primarily for internal use by Coder to create modules compatible with Tasks.
|
|
|
|
```tf
|
|
module "agentapi" {
|
|
source = "registry.coder.com/coder/agentapi/coder"
|
|
version = "3.0.0"
|
|
|
|
agent_id = var.agent_id
|
|
web_app_slug = local.app_slug
|
|
web_app_order = var.order
|
|
web_app_group = var.group
|
|
web_app_icon = var.icon
|
|
web_app_display_name = "Goose"
|
|
cli_app_slug = "goose-cli"
|
|
cli_app_display_name = "Goose CLI"
|
|
module_dir_name = local.module_dir_name
|
|
agentapi_server_type = "claude"
|
|
install_agentapi = var.install_agentapi
|
|
pre_install_script = var.pre_install_script
|
|
post_install_script = var.post_install_script
|
|
start_script = local.start_script
|
|
agentapi_server_type = "claude" # required
|
|
agentapi_term_width = 67 # default: 67
|
|
agentapi_term_height = 1190 # default: 1190
|
|
agentapi_initial_prompt = "You are a helpful assistant." # optional
|
|
install_script = <<-EOT
|
|
#!/bin/bash
|
|
set -o errexit
|
|
set -o pipefail
|
|
|
|
echo -n '${base64encode(local.install_script)}' | base64 -d > /tmp/install.sh
|
|
chmod +x /tmp/install.sh
|
|
|
|
ARG_PROVIDER='${var.goose_provider}' \
|
|
ARG_MODEL='${var.goose_model}' \
|
|
ARG_GOOSE_CONFIG="$(echo -n '${base64encode(local.combined_extensions)}' | base64 -d)" \
|
|
ARG_INSTALL='${var.install_goose}' \
|
|
ARG_GOOSE_VERSION='${var.goose_version}' \
|
|
/tmp/install.sh
|
|
EOT
|
|
}
|
|
```
|
|
|
|
## Task log snapshot
|
|
|
|
Captures the last 10 messages from AgentAPI when a task workspace stops. This allows viewing conversation history while the task is paused.
|
|
|
|
To enable for task workspaces:
|
|
|
|
```tf
|
|
module "agentapi" {
|
|
# ... other config
|
|
task_log_snapshot = true # default: true
|
|
}
|
|
```
|
|
|
|
## For module developers
|
|
|
|
For a complete example of how to use this module, see the [Goose module](https://github.com/coder/registry/blob/main/registry/coder/modules/goose/main.tf).
|
|
|
|
### Start script behavior
|
|
|
|
The `start_script` should write the agent command to `$module_path/agent-command.sh` instead of starting the AgentAPI server directly.
|
|
|
|
Example start script:
|
|
|
|
```bash
|
|
#!/bin/bash
|
|
module_path="$HOME/.my-module"
|
|
|
|
cat > "$module_path/agent-command.sh" << EOF
|
|
#!/bin/bash
|
|
my-agent-command --my-agent-flags
|
|
EOF
|
|
|
|
chmod +x "$module_path/agent-command.sh"
|
|
```
|