Sign in

Get v0 city by city name session by ID

Changed on
get/v0/city/{cityName}/session/{id}

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

cityNamestring required

City name.

idstring required

Session ID, alias, or runtime session_name.

Query parameters

peekboolean

Include last output preview.

peek_linesinteger

Number of lines to include in the last output preview when peek=true. Defaults to 5.

exact_idboolean

Resolve {id} as an exact session bead id only: a single point read that also finds closed sessions and answers 404 when no bead has that id. Skips the alias, runtime session_name, configured-name and closed-session name lookups. For callers holding a durable id.

Response

OK

active_beadstring
activitystring
agent_kindstring
aliasstring
attachedboolean required
configured_named_sessionboolean
context_pctinteger
context_windowinteger
created_atstring required
display_namestring
idstring required
kindstring
last_activestring
last_nudge_delivered_atstring
last_outputstring
metadataobject
modelstring
optionsobject
poolstring
providerstring required
reasonstring
rigstring
runningboolean required
session_namestring required
statestring required
templatestring required
titlestring required
work_dirstring

Changes