SignOps Live Activities API
The Live Activities API from SignOps — 5 operation(s) for live activities.
The Live Activities API from SignOps — 5 operation(s) for live activities.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/signops:signops-live-activities-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: SignOps Live Activities API
version: 1.0.0
description: 'Push notifications to Android, iOS and the web, login approval on a trusted phone, passkeys, authenticator codes and email OTP, on one API key and your own user ids. Errors are { error: { code, message } }. Test keys (sk_test_) send only to test devices and addresses and are not billed.'
contact:
email: hello@signops.dev
url: https://signops.dev/docs/
termsOfService: https://signops.dev/terms/
servers:
- url: https://api.signops.dev
security:
- secretKey: []
tags:
- name: Live Activities
paths:
/v1/activities:
post:
operationId: postActivities
summary: Start a Live Activity or ongoing notification (Starter and Pro)
tags:
- Live Activities
security:
- secretKey: []
parameters:
- name: Idempotency-Key
in: header
required: false
description: The same key within 24 hours returns the first result instead of acting twice.
schema:
type: string
maxLength: 128
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ActivityStart'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
4XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/v1/activities/{ref}:
get:
operationId: getActivitiesByRef
summary: Get an activity
tags:
- Live Activities
security:
- secretKey: []
parameters:
- name: ref
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
4XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/v1/activities/{ref}/update:
post:
operationId: postActivitiesByRefUpdate
summary: Update an activity
tags:
- Live Activities
security:
- secretKey: []
parameters:
- name: ref
in: path
required: true
schema:
type: string
- name: Idempotency-Key
in: header
required: false
description: The same key within 24 hours returns the first result instead of acting twice.
schema:
type: string
maxLength: 128
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ActivityState'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
4XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/v1/activities/{ref}/end:
post:
operationId: postActivitiesByRefEnd
summary: End an activity
tags:
- Live Activities
security:
- secretKey: []
parameters:
- name: ref
in: path
required: true
schema:
type: string
- name: Idempotency-Key
in: header
required: false
description: The same key within 24 hours returns the first result instead of acting twice.
schema:
type: string
maxLength: 128
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ActivityState'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
4XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/v1/activities/{ref}/token:
post:
operationId: postActivitiesByRefToken
summary: 'iOS SDK: the Live Activity''s push token'
tags:
- Live Activities
security:
- publishableKey: []
parameters:
- name: ref
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
push_token:
type: string
description: ActivityKit push token.
required:
- push_token
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
ref:
type: string
description: Your ref.
ios:
type: boolean
description: 'true'
4XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
ActivityState:
type: object
properties:
title:
type: string
description: 'Android: title.'
body:
type: string
description: 'Android: text.'
progress:
type: integer
description: 0 to 100 draws a progress bar.
minimum: 0
maximum: 100
content_state:
type: object
properties: {}
description: 'iOS: the object your ContentState decodes.'
alert:
type: object
properties:
title:
type: string
description: Title.
body:
type: string
description: Text.
description: 'iOS: light the screen for this update.'
stale_at:
type: string
description: ISO 8601 time.
format: date-time
dismiss_at:
type: string
description: ISO 8601 time.
format: date-time
priority:
type: string
description: high sends at Apple's high priority without an alert.
enum:
- high
Error:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: Machine-readable code, like invalid_request, rate_limited or expired.
message:
type: string
description: Written for a developer to read.
required:
- code
- message
required:
- error
ActivityStart:
type: object
properties:
ref:
type: string
description: Your own id for the activity, like an order id.
user_id:
type: string
description: Your own id for the user, up to 128 characters without spaces.
maxLength: 128
title:
type: string
description: 'Android: title.'
body:
type: string
description: 'Android: text.'
progress:
type: integer
description: 0 to 100 draws a progress bar.
minimum: 0
maximum: 100
content_state:
type: object
properties: {}
description: 'iOS: the object your ContentState decodes.'
alert:
type: object
properties:
title:
type: string
description: Title.
body:
type: string
description: Text.
description: 'iOS: light the screen for this update.'
stale_at:
type: string
description: ISO 8601 time.
format: date-time
dismiss_at:
type: string
description: ISO 8601 time.
format: date-time
priority:
type: string
description: high sends at Apple's high priority without an alert.
enum:
- high
required:
- ref
- user_id
securitySchemes:
secretKey:
type: http
scheme: bearer
description: sk_live_... or sk_test_..., on your server only.
publishableKey:
type: http
scheme: bearer
description: pk_live_... or pk_test_..., used by the SDKs in apps and browsers.
externalDocs:
description: Docs
url: https://signops.dev/docs/