sessions

Start a session-owned server from .ao/launch.json and open its application preview

Changed on
post/api/v1/sessions/{sessionId}/preview/server

Request

  • Base URL
    http://127.0.0.1:3001
  • URL
    http://127.0.0.1:3001/api/v1/sessions/{sessionId}/preview/server
  • Auth
    none declared

Path parameters

sessionIdstring required

Session identifier, e.g. project-1.

Headers

X-AO-Browser-Capabilitystring

Opaque browser capability injected into the owning AO worker.

X-AO-Preview-Capabilitystring

Opaque preview-only capability injected into a session-scoped user shell.

Request body

configurationstring

Named preview configuration. Optional when exactly one configuration exists.

Response

OK

configurationstring
errorstring
logsstring[] required
portinteger
sessionIdstring required
startedAtstring date-time
state'stopped' | 'starting' | 'ready' | 'stopping' | 'failed' required
targetKind'app' | 'api'
urlstring

Changes

  • 8f160e6183cdRevision changes
    • info

      removed the agent_switch_saga enum value from the response property for the response status

    • info

      removed the agent_switch_saga enum value from the response property for the response status

    • info

      removed the agent_switch_saga enum value from the response property for the response status

    • info

      removed the agent_switch_saga enum value from the response property for the response status

    • info

      removed the agent_switch_saga enum value from the response property for the response status

    • info

      removed the agent_switch_saga enum value from the response property for the response status

    • info

      removed the agent_switch_saga enum value from the response property for the response status

    • info

      removed the agent_switch_saga enum value from the response property for the response status

    • info

      removed the agent_switch_saga enum value from the response property for the response status

  • ac97dcafa186Revision changes
    • info

      added the new optional header request parameter X-AO-Preview-Capability