Files
goose/api_clients/bash/docs/SessionManagementApi.md
2025-10-02 20:13:20 -04:00

3.7 KiB

SessionManagementApi

All URIs are relative to **

Method HTTP request Description
deleteSession DELETE /sessions/{session_id}
getSession GET /sessions/{session_id}
getSessionInsights GET /sessions/insights
listSessions GET /sessions
updateSessionDescription PUT /sessions/{session_id}/description

deleteSession

Example

goose-api deleteSession session_id=value

Parameters

Name Type Description Notes
sessionId string Unique identifier for the session [default to null]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: Not Applicable

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSession

Example

goose-api getSession session_id=value

Parameters

Name Type Description Notes
sessionId string Unique identifier for the session [default to null]

Return type

Session

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSessionInsights

Example

goose-api getSessionInsights

Parameters

This endpoint does not need any parameter.

Return type

SessionInsights

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listSessions

Example

goose-api listSessions

Parameters

This endpoint does not need any parameter.

Return type

SessionListResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateSessionDescription

Example

goose-api updateSessionDescription session_id=value

Parameters

Name Type Description Notes
sessionId string Unique identifier for the session [default to null]
updateSessionDescriptionRequest UpdateSessionDescriptionRequest

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: Not Applicable

[Back to top] [Back to API list] [Back to Model list] [Back to README]