Get Form Filling Session Status

Use this endpoint to know the processing status for a form-filling session. Use your ambient session identifier (id) to identify the session you want to check the status of.

Form filling session status values

Use the following status values to track session progress:

created: The system creates the form-filling session but does not start it yet.
ready: The form-filling session starts and is ready for audio streaming.
running: The form-filling session processes audio and generates content.
staged: The form-filling session is staged and is ready to be processed.
aborted: The user or client cancels the form-filling session.
failed: An error stops the form-filling session during processing.
completed: The form-filling session completes successfully and generates the final content.

Code examples

The code examples below use placeholders and the stage host sdp.suki-stage.com only as examples. For credentials, base URLs, where to run Python or TypeScript, CORS, and cURL, refer to Using code examples in your integration in the API Reference Guidelines.

Python
TypeScript

from typing import Any, Literal, TypedDict

import requests

BASE_URL = "https://sdp.suki-stage.com"

StatusValue = Literal[
    "created",
    "ready",
    "running",
    "paused",
    "aborted",
    "failed",
    "completed",
    "staged",
]


class StatusResponse(TypedDict):
    status: StatusValue


class ApiHttpError(RuntimeError):
    """Wrong HTTP status; OpenAPI errors usually include JSON with message + code."""

    def __init__(self, status: int, url: str, detail: str) -> None:
        super().__init__(f"HTTP {status} {url}: {detail}")
        self.status = status
        self.url = url


def _get_expect_json_object(url: str, headers: dict[str, str], expect_status: int) -> dict[str, Any]:
    r = requests.get(url, headers=headers, timeout=60)
    if r.status_code == expect_status:
        data = r.json()
        if isinstance(data, dict):
            return data
        raise ApiHttpError(expect_status, url, "response JSON was not an object")

    detail = ""
    try:
        err = r.json()
        if isinstance(err, dict) and isinstance(err.get("message"), str):
            detail = err["message"]
    except ValueError:
        detail = (r.text or "")[:500]
    raise ApiHttpError(r.status_code, url, detail or "(no body)")


def get_form_filling_session_status(suki_token: str, ambient_session_id: str) -> StatusResponse:
    """GET /api/v1/form-filling/session/{ambient_session_id}/status (sdp_suki_token header required). HTTP 200."""
    url = f"{BASE_URL}/api/v1/form-filling/session/{ambient_session_id}/status"
    data = _get_expect_json_object(url, {"sdp_suki_token": suki_token}, 200)
    status = data.get("status")
    if not isinstance(status, str) or not status:
        raise ValueError(f"{url}: 200 response missing status")
    return {"status": status}  # type: ignore[return-value]


if __name__ == "__main__":
    try:
        out = get_form_filling_session_status("YOUR_SUKI_TOKEN", "YOUR_AMBIENT_SESSION_ID")
        print(out["status"])
    except (ApiHttpError, ValueError) as e:
        print(e)

const BASE_URL = "https://sdp.suki-stage.com";

type StatusValue =
  | "created"
  | "ready"
  | "running"
  | "paused"
  | "aborted"
  | "failed"
  | "completed";

type StatusResponse = { status: StatusValue };

class ApiHttpError extends Error {
  status: number;
  url: string;
  constructor(status: number, url: string, detail: string) {
    super(`HTTP ${status} ${url}: ${detail}`);
    this.status = status;
    this.url = url;
  }
}

async function getExpectJsonObject(url: string, headers: Record<string, string>, expectStatus: number) {
  const res = await fetch(url, { method: "GET", headers });
  const text = await res.text();
  const json = text ? JSON.parse(text) : {};

  if (res.status !== expectStatus) {
    const msg = typeof (json as any)?.message === "string" ? (json as any).message : text?.slice(0, 500) || "(no body)";
    throw new ApiHttpError(res.status, url, msg);
  }
  if (json && typeof json === "object" && !Array.isArray(json)) return json as Record<string, unknown>;
  throw new ApiHttpError(res.status, url, "response JSON was not an object");
}

export async function getFormFillingSessionStatus(sukiToken: string, ambientSessionId: string): Promise<StatusResponse> {
  const url = `${BASE_URL}/api/v1/form-filling/session/${ambientSessionId}/status`;
  const data = await getExpectJsonObject(url, { sdp_suki_token: sukiToken }, 200);
  const status = data.status;
  if (typeof status !== "string" || !status) {
    throw new Error(`${url}: 200 response missing status`);
  }
  return { status: status as StatusValue };
}

// Example usage
const out = await getFormFillingSessionStatus("YOUR_SUKI_TOKEN", "YOUR_AMBIENT_SESSION_ID");
console.log(out.status);

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 /api/v1/form-filling/session/{ambient_session_id}/status.

status

enum<string>

status of the form-filling session

Available options:

created,

ready,

running,

paused,

aborted,

failed,

completed

Example:

"completed"

Documentation Index

​Form filling session status values

​Code examples

Headers

Path Parameters

Response

Form filling session status values

Code examples