Skip to content

feat(api): add single-session status HTTP endpoint #29244

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hemanthreddykoduru wants to merge 6 commits into
base: dev
Choose a base branch
from
+19 −0
Open

feat(api): add single-session status HTTP endpoint #29244

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9b0be41
feat(api): add single-session status HTTP endpoint
hemanthreddykoduru May 25, 2026
ff3af2c
fix(api): address copilot review on requireSession declaration order
hemanthreddykoduru May 25, 2026
8dbe52b
Merge branch 'dev' into fix/session-status-endpoint
hemanthreddykoduru May 25, 2026
1c2f72a
refactor(api): rename singleStatus endpoint to getStatus as per PR fe…
hemanthreddykoduru May 25, 2026
8b271e7
Merge branch 'dev' into fix/session-status-endpoint
hemanthreddykoduru May 25, 2026
c9c5c99
refactor(api): rename SessionPaths.singleStatus to getStatus for cons…
hemanthreddykoduru May 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions packages/opencode/src/server/routes/instance/httpapi/groups/session.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ export const PermissionResponsePayload = Schema.Struct({
export const SessionPaths = {
list: root,
status: `${root}/status`,
getStatus: `${root}/:sessionID/status`,
get: `${root}/:sessionID`,
children: `${root}/:sessionID/children`,
todo: `${root}/:sessionID/todo`,
Expand Down Expand Up @@ -125,6 +126,18 @@ export const SessionApi = HttpApi.make("session")
description: "Retrieve the current status of all sessions, including active, idle, and completed states.",
}),
),
HttpApiEndpoint.get("getStatus", SessionPaths.getStatus, {
params: { sessionID: SessionID },
query: WorkspaceRoutingQuery,
success: described(SessionStatus.Info, "Get single session status"),
error: [HttpApiError.BadRequest, ApiNotFoundError],
}).annotateMerge(
OpenApi.annotations({
identifier: "session.getStatus",
summary: "Get single session status",
description: "Retrieve the current status of a specific session.",
}),
),
HttpApiEndpoint.get("get", SessionPaths.get, {
params: { sessionID: SessionID },
query: WorkspaceRoutingQuery,
Expand Down
6 changes: 6 additions & 0 deletions packages/opencode/src/server/routes/instance/httpapi/handlers/session.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,11 @@ export const sessionHandlers = HttpApiBuilder.group(InstanceHttpApi, "session",
return yield* SessionError.mapStorageNotFound(session.get(sessionID))
})

const getStatus = Effect.fn("SessionHttpApi.getStatus")(function* (ctx: { params: { sessionID: SessionID } }) {
yield* requireSession(ctx.params.sessionID)
return yield* statusSvc.get(ctx.params.sessionID)
Comment on lines +83 to +84
Comment on lines +83 to +84
Copy link
Copy Markdown
Author

@hemanthreddykoduru hemanthreddykoduru May 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keeping requireSession intentionally. statusSvc.get() reads from an in-memory Map (via InstanceState.get) and always returns { type: "idle" } for any unknown sessionID — it never fails. Removing requireSession would cause this endpoint to return 200 idle for completely non-existent sessions instead of a proper 404. The two calls serve different purposes: requireSession validates session existence against storage, statusSvc.get reads runtime status from memory.

})

const get = Effect.fn("SessionHttpApi.get")(function* (ctx: { params: { sessionID: SessionID } }) {
return yield* requireSession(ctx.params.sessionID)
})
Expand Down Expand Up @@ -406,6 +411,7 @@ export const sessionHandlers = HttpApiBuilder.group(InstanceHttpApi, "session",
return handlers
.handle("list", list)
.handle("status", status)
.handle("getStatus", getStatus)
.handle("get", get)
.handle("children", children)
.handle("todo", todo)
Expand Down
Loading