Skip to main content

openhands.server.routes.conversation

get_remote_runtime_config

@app.get('/config')
async def get_remote_runtime_config(request: Request)

Retrieve the runtime configuration.

Currently, this is the session ID and runtime ID (if available).

get_vscode_url

@app.get('/vscode-url')
async def get_vscode_url(request: Request)

Get the VSCode URL.

This endpoint allows getting the VSCode URL.

Arguments:

  • request Request - The incoming FastAPI request object.

Returns:

  • JSONResponse - A JSON response indicating the success of the operation.

search_events

@app.get('/events/search')
async def search_events(request: Request,
query: str | None = None,
start_id: int = 0,
limit: int = 20,
event_type: str | None = None,
source: str | None = None,
start_date: str | None = None,
end_date: str | None = None)

Search through the event stream with filtering and pagination.

Arguments:

  • request Request - The incoming request object
  • query str, optional - Text to search for in event content
  • start_id int - Starting ID in the event stream. Defaults to 0
  • limit int - Maximum number of events to return. Must be between 1 and 100. Defaults to 20
  • event_type str, optional - Filter by event type (e.g., "FileReadAction")
  • source str, optional - Filter by event source
  • start_date str, optional - Filter events after this date (ISO format)
  • end_date str, optional - Filter events before this date (ISO format)

Returns:

  • dict - Dictionary containing:
    • events: List of matching events
    • has_more: Whether there are more matching events after this batch

Raises:

  • HTTPException - If conversation is not found
  • query0 - If limit is less than 1 or greater than 100