Node

import ActivitySmith from "activitysmith";

const activitysmith = new ActivitySmith({
  apiKey: process.env.ACTIVITYSMITH_API_KEY,
});

await activitysmith.liveActivities.endStream("prod-web-1", {
  content_state: {
    title: "Server Health",
    subtitle: "prod-web-1",
    type: "metrics",
    metrics: [
      { label: "CPU", value: 7, unit: "%" },
      { label: "MEM", value: 38, unit: "%" },
    ],
  },
});

import os
from activitysmith import ActivitySmith

activitysmith = ActivitySmith(api_key=os.environ["ACTIVITYSMITH_API_KEY"])

activitysmith.live_activities.end_stream(
    "prod-web-1",
    {
        "content_state": {
            "title": "Server Health",
            "subtitle": "prod-web-1",
            "type": "metrics",
            "metrics": [
                {"label": "CPU", "value": 7, "unit": "%"},
                {"label": "MEM", "value": 38, "unit": "%"},
            ],
        },
    },
)

package main

import (
	"log"

	activitysmithsdk "github.com/ActivitySmithHQ/activitysmith-go"
	"github.com/ActivitySmithHQ/activitysmith-go/generated"
)

func main() {
	activitysmith, err := activitysmithsdk.New("YOUR-API-KEY")
	if err != nil {
		log.Fatal(err)
	}

	_, err = activitysmith.LiveActivities.EndStream("prod-web-1", activitysmithsdk.LiveActivityStreamEndInput{
		Title:    "Server Health",
		Subtitle: "prod-web-1",
		Type:     "metrics",
		Metrics: []generated.ActivityMetric{
			{Label: "CPU", Value: 7, Unit: generated.PtrString("%")},
			{Label: "MEM", Value: 38, Unit: generated.PtrString("%")},
		},
	})
	if err != nil {
		log.Fatal(err)
	}
}

<?php

use ActivitySmith\ActivitySmith;

$activitysmith = new ActivitySmith($_ENV['ACTIVITYSMITH_API_KEY']);

$activitysmith->liveActivities->endStream('prod-web-1', [
    'content_state' => [
        'title' => 'Server Health',
        'subtitle' => 'prod-web-1',
        'type' => 'metrics',
        'metrics' => [
            ['label' => 'CPU', 'value' => 7, 'unit' => '%'],
            ['label' => 'MEM', 'value' => 38, 'unit' => '%'],
        ],
    ],
]);

require "activitysmith"

activitysmith = ActivitySmith::Client.new(api_key: ENV.fetch("ACTIVITYSMITH_API_KEY"))

activitysmith.live_activities.end_stream(
  "prod-web-1",
  {
    content_state: {
      title: "Server Health",
      subtitle: "prod-web-1",
      type: "metrics",
      metrics: [
        { label: "CPU", value: 7, unit: "%" },
        { label: "MEM", value: 38, unit: "%" }
      ]
    }
  }
)

curl -X DELETE "https://activitysmith.com/api/live-activity/stream/prod-web-1" \
  -H "Authorization: Bearer $ACTIVITYSMITH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "content_state": {
      "title": "Server Health",
      "subtitle": "prod-web-1",
      "type": "metrics",
      "metrics": [
        { "label": "CPU", "value": 7, "unit": "%" },
        { "label": "MEM", "value": 38, "unit": "%" }
      ]
    }
  }'

{
  "success": true,
  "operation": "ended",
  "stream_key": "prod-web-1",
  "activity_id": "h8QmSyYFTuwOIF6Wh3YcZlzHLhUcr034",
  "devices_queued": 1,
  "timestamp": "2025-08-12T12:10:00.000Z"
}

Live Activities Endpoints

End Live Activity Stream

Use this endpoint when the process you are tracking is finished and you no longer want the Live Activity on your devices. ActivitySmith ends the current Live Activity for this stream and dismisses it from devices. If you need direct lifecycle control, use /live-activity/start, /live-activity/update, and /live-activity/end instead. Use secondary_action for a second button on alert, progress, and segmented_progress Live Activities.

DELETE

live-activity

stream

{stream_key}

Node

import ActivitySmith from "activitysmith";

const activitysmith = new ActivitySmith({
  apiKey: process.env.ACTIVITYSMITH_API_KEY,
});

await activitysmith.liveActivities.endStream("prod-web-1", {
  content_state: {
    title: "Server Health",
    subtitle: "prod-web-1",
    type: "metrics",
    metrics: [
      { label: "CPU", value: 7, unit: "%" },
      { label: "MEM", value: 38, unit: "%" },
    ],
  },
});

import os
from activitysmith import ActivitySmith

activitysmith = ActivitySmith(api_key=os.environ["ACTIVITYSMITH_API_KEY"])

activitysmith.live_activities.end_stream(
    "prod-web-1",
    {
        "content_state": {
            "title": "Server Health",
            "subtitle": "prod-web-1",
            "type": "metrics",
            "metrics": [
                {"label": "CPU", "value": 7, "unit": "%"},
                {"label": "MEM", "value": 38, "unit": "%"},
            ],
        },
    },
)

package main

import (
	"log"

	activitysmithsdk "github.com/ActivitySmithHQ/activitysmith-go"
	"github.com/ActivitySmithHQ/activitysmith-go/generated"
)

func main() {
	activitysmith, err := activitysmithsdk.New("YOUR-API-KEY")
	if err != nil {
		log.Fatal(err)
	}

	_, err = activitysmith.LiveActivities.EndStream("prod-web-1", activitysmithsdk.LiveActivityStreamEndInput{
		Title:    "Server Health",
		Subtitle: "prod-web-1",
		Type:     "metrics",
		Metrics: []generated.ActivityMetric{
			{Label: "CPU", Value: 7, Unit: generated.PtrString("%")},
			{Label: "MEM", Value: 38, Unit: generated.PtrString("%")},
		},
	})
	if err != nil {
		log.Fatal(err)
	}
}

<?php

use ActivitySmith\ActivitySmith;

$activitysmith = new ActivitySmith($_ENV['ACTIVITYSMITH_API_KEY']);

$activitysmith->liveActivities->endStream('prod-web-1', [
    'content_state' => [
        'title' => 'Server Health',
        'subtitle' => 'prod-web-1',
        'type' => 'metrics',
        'metrics' => [
            ['label' => 'CPU', 'value' => 7, 'unit' => '%'],
            ['label' => 'MEM', 'value' => 38, 'unit' => '%'],
        ],
    ],
]);

require "activitysmith"

activitysmith = ActivitySmith::Client.new(api_key: ENV.fetch("ACTIVITYSMITH_API_KEY"))

activitysmith.live_activities.end_stream(
  "prod-web-1",
  {
    content_state: {
      title: "Server Health",
      subtitle: "prod-web-1",
      type: "metrics",
      metrics: [
        { label: "CPU", value: 7, unit: "%" },
        { label: "MEM", value: 38, unit: "%" }
      ]
    }
  }
)

curl -X DELETE "https://activitysmith.com/api/live-activity/stream/prod-web-1" \
  -H "Authorization: Bearer $ACTIVITYSMITH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "content_state": {
      "title": "Server Health",
      "subtitle": "prod-web-1",
      "type": "metrics",
      "metrics": [
        { "label": "CPU", "value": 7, "unit": "%" },
        { "label": "MEM", "value": 38, "unit": "%" }
      ]
    }
  }'

{
  "success": true,
  "operation": "ended",
  "stream_key": "prod-web-1",
  "activity_id": "h8QmSyYFTuwOIF6Wh3YcZlzHLhUcr034",
  "devices_queued": 1,
  "timestamp": "2025-08-12T12:10:00.000Z"
}

Use this endpoint when the process you are tracking is finished and you want to dismiss the managed Live Activity stream.

Call it with the same stream_key you used for stream updates.
You can include optional content_state with final values.
By default, iOS removes the Live Activity after two minutes.
Set auto_dismiss_minutes to choose a different dismissal time, including 0 for immediate dismissal.

Authorizations

Authorization

string

header

required

Required. Include Authorization: Bearer ask_123456789 in every request. Replace ask_123456789 with your API key.

Path Parameters

stream_key

string

required

Stable identifier for one ongoing thing. Allowed characters: letters, numbers, underscores, and hyphens.

Maximum string length: 255

Pattern: ^[A-Za-z0-9_-]+$

Body

application/json

Optional payload for ending a managed stream. When omitted, ActivitySmith ends the stream using the latest known state when possible.

content_state

object

Current state for a managed Live Activity stream. Include type on the first PUT, and whenever the stream may need to start a fresh activity. Supports segmented_progress, progress, metrics, stats, alert, and timer types. For timer, send duration_seconds to start or reset a bounded timer; omit duration_seconds on later updates to preserve the existing timer window.

Show child attributes

action

object

Optional action button shown in the Live Activity UI. Use action for the primary button, or secondary_action for a secondary button on alert, progress, and segmented_progress Live Activities.

Show child attributes

secondary_action

object

Optional secondary action button. Supported for alert, progress, and segmented_progress Live Activities. Uses the same open_url, shortcuts://, and webhook shapes as action.

Show child attributes

alert

object

Show child attributes

Response

Managed stream ended

Returned after a managed stream is ended and removed.

success

boolean

required

operation

enum<string>

required

Available options:

ended

stream_key

string

required

timestamp

string<date-time>

required

activity_id

string | null

devices_queued

integer

devices_notified

integer

Live Activity Stream

Start Live Activity

Using API

Push Notifications Endpoints

Live Activities Endpoints

Widgets Endpoints

App Icon Badge Count Endpoints

Resources

End Live Activity Stream

Authorizations

Path Parameters

Body

Response