Get project
GET /api/v1/projects/{projectId}/{agentType}
Returns a single project enriched with live container state, Claude status, worktree counts, and cost data.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Project ID
Agent type
Responses
Section titled “ Responses ”OK
object
ActiveWorktreeCount is the number of worktrees with connected terminals.
AgentStatus is the agent activity state (“idle”, “working”, “unknown”).
AgentType identifies the CLI agent running in this project (e.g. “claude-code”, “codex”).
AgentVersion is the pinned CLI version installed in this container.
AllowedDomains lists domains accessible when NetworkMode is “restricted”.
CloneURL is the git repository URL to clone (remote projects only).
CostBudget is the per-project cost limit in USD (0 = use global default).
ForwardedPorts lists container ports exposed via the reverse proxy.
HasContainer is true when a Docker container is associated with this project.
HostPath is the absolute host directory mounted into the container (local projects only).
ID is the Docker container ID (empty when no container exists).
IsEstimatedCost is true when the cost is an estimate (e.g. subscription users).
IsGitRepo indicates whether the container’s /project is a git repository.
MountedDir is the host directory mounted into the container.
Name is the user-chosen display label / Docker container name.
NeedsInput is true when any worktree requires user attention.
NetworkMode controls the container’s network isolation level.
NotificationType indicates why the agent needs attention (e.g. “permission_prompt”, “idle_prompt”, “elicitation_dialog”).
ProjectID is the deterministic project identifier (sha256 of host path or clone URL, 12 hex chars).
SkipPermissions indicates whether terminals should skip permission prompts.
Source indicates whether the project is local (host mount) or remote (git clone).
State is the Docker container state (“running”, “exited”, “not-found”, etc).
Status is the Docker container status string (e.g. “Up 2 hours”).
Temporary is true when a remote project’s workspace is ephemeral (lost on container recreate).
TotalCost is the aggregate cost across all worktrees in USD.
WorkspaceDir is the container-side workspace directory (mount destination).
Bad Request
object
Not Found
object
Internal Server Error