@archastro/sdk
    Preparing search index...
    Index

    Constructors

    Methods

    Constructors

    Methods

    • Retrieve an automation run Returns a single automation run by ID. Public v1 path: GET /api/v1/automation_runs/:automation_run. Developer app-scoped path (legacy shape, same module): GET /protected/api/v1/developer/apps/:app/automations/runs/:automation_run. Any automation type is accepted (trigger, scheduled, or invoked). Resolution is viewer-scoped (AppScope + OrgScope): a run the caller cannot see returns 404.

      Parameters

      • automationRun: string

        Automation run ID (arun_...).

      Returns Promise<AutomationRun>

      The requested automation run.

    • List an automation run journal Returns durable workflow journal entries for an automation run. Public v1 path: GET /api/v1/automation_runs/:automation_run/journal. Developer app-scoped path (legacy shape, same module): GET /protected/api/v1/developer/apps/:app/automations/runs/:automation_run/journal. Any automation type is accepted. Resolution is viewer-scoped (AppScope + OrgScope). An authorized run without a journal returns journal: null and an empty data array with HTTP 200.

      Parameters

      • automationRun: string

        Automation run ID (atr_...) whose journal to retrieve.

      • Optionalparams: { afterCursor?: string; limit?: number }

        Query parameters.

        • OptionalafterCursor?: string

          Opaque cursor from the previous response's after_cursor field.

        • Optionallimit?: number

          Maximum number of entries to return. Defaults to 50; maximum is 100.

      Returns Promise<RunJournalPage>

      Forward-paginated automation run journal entries.

    • Stream automation run status Opens a Server-Sent Events connection that emits a run_update event whenever the invoked automation run's status changes, replaying the current status on connect and closing on a terminal status (completed, failed, cancelled) or after the max stream duration.

      Parameters

      • automationRun: string

        ID of the invoked automation run.

      Returns AsyncIterable<{ data: AutomationRun; event: "run_update" }>

      Server-Sent Events stream