Skip to main content
GET
/
api
/
v1
/
ambient
/
session
/
{ambient_session_id}
/
status
Gets the status of the ambient session.
curl --request GET \
  --url https://sdp.suki-stage.com/api/v1/ambient/session/{ambient_session_id}/status \
  --header 'sdp_suki_token: <sdp_suki_token>'
{
  "status": "completed"
}
Use this endpoint to get the current status of an ambient session. You can use this to track the session’s progress, for example, to see if it is ready to receive audio, still processing, or has completed.

​
Session Status Values

  • created - Ambient session has been created but not yet started
  • ready - Ambient session has been started and is ready for audio streaming
  • running - Ambient session is actively processing audio and generating content
  • paused - Ambient session is temporarily paused
  • aborted - Ambient session has been aborted by the client
  • failed - Ambient session failed due to an error during processing
  • completed - Ambient session completed successfully and generated the final content
Upon reaching completed state, the session is ready to return the content, transcripts or other structured data.

Headers

​
sdp_suki_token
string
required

sdp_suki_token

Path Parameters

​
ambient_session_id
string
required

ambient_session_id

Response

Success Response

Response body for the /session/{ambient_session_id}/status endpoint

​
status
enum<string>

status of the ambient session

Available options:
created,
ready,
running,
paused,
aborted,
failed,
completed
Example:

"completed"

⌘I