Airship REST API

Name: Airship REST API
Brand: Airship REST API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentCommunicationsPush Notificationsbasic16 EndpointsREST

For Agents

Send push notifications, validate payloads before sending, and manage channels, named users, and tags across mobile and web audiences.

Install Jentic One Beta

Connect the Airship REST API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Airship REST API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Airship REST API.

Send push notifications to channels, segments, named users, or tags via POST /push

Validate a push payload without sending via POST /push/validate

Look up an individual channel record by channel ID

GET STARTED

Start building with Airship REST API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI specification for Airship REST API, keeping it validated and agent-ready. Airship is a customer engagement platform best known for push notifications across iOS, Android, and web, with extensions for in-app messages, named-user identity, segmentation, and tags. The 16 documented endpoints cover sending and validating pushes, managing channels and named users, associating channels with named-user IDs, and bulk tag operations. Authentication uses HTTP Basic with the Airship app key and master secret.

Use Cases

Patterns agents use Airship REST API for, with concrete tasks.

★ Cross-Platform Push Broadcast

Send a single push notification to a unified audience across iOS, Android, and web by POSTing a payload to /push with an audience selector and platform overrides. Airship handles fan-out, retries, and per-platform formatting (APNs, FCM, web push). Suitable for marketing announcements, news alerts, and product launch broadcasts.

Send a push to audience { 'tag': 'subscribers' } with title 'Sale Today' and verify the response returns push_ids

Named-User Identity Mapping

Associate device channels with a stable named-user identifier so a logged-in customer receives pushes on every registered device. POST /named_users/associate links a channel to a named-user ID; /named_users/disassociate reverses the link. The /named_users and /named_users/{named_user_id} endpoints expose the resulting identity graph.

Associate channel 'ch-12345' with named_user 'user-987' and confirm by looking up named_user 'user-987'

Bulk Tag Management

Apply or remove tags across many channels or named users in a single API call via POST /channels/tags or POST /named_users/tags. Useful for syncing CRM segments to Airship, reacting to lifecycle events, or running re-engagement campaigns scoped to tagged audiences.

Add tag 'paid_user' to named_users ['user-1', 'user-2', 'user-3'] in a single bulk request

Pre-Send Payload Validation

Catch malformed pushes before they hit the production audience by POSTing the payload to /push/validate. Airship returns the same validation errors it would surface during a real send, without dispatching to devices. Use during template development and CI checks.

Validate a push payload targeting tag 'beta_testers' and confirm the response returns ok:true

Agent Push Sending via Jentic

An agent triggers Airship pushes by searching Jentic for the send-push operation, loading its schema, and executing with the audience and notification body. Jentic injects the Basic auth header derived from the Airship app key and master secret stored in the credential vault.

Search Jentic for 'send a push notification', load the Airship POST /push operation, and execute with audience 'all' and a transactional alert body

Key Endpoints

16 endpoints — jentic publishes the only available openapi specification for airship rest api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/push

Send a push notification to an audience

POST

/push/validate

Validate a push payload without sending

GET

/channels

List device channels

GET

/channels/{channel_id}

Look up a channel by ID

POST

/channels/tags

Add or remove tags in bulk on channels

POST

/named_users/associate

Associate a channel with a named user

POST

/named_users/disassociate

Disassociate a channel from a named user

POST

/named_users/tags

Add or remove tags on named users

POST

/push

Send a push notification to an audience

POST

/push/validate

Validate a push payload without sending

GET

/channels

List device channels

GET

/channels/{channel_id}

Look up a channel by ID

POST

/channels/tags

Add or remove tags in bulk on channels

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Airship app keys and master secrets are stored encrypted in the Jentic vault. The Basic auth header is constructed at execution time and the master secret never enters the agent's context.

Intent-based discovery

Agents search by intent ('send a push notification', 'add a tag to channels') and Jentic returns the matching POST operation with its audience and notification schema.

Time to first call

Direct Airship integration: 2-5 days for auth setup, audience modelling, and per-platform overrides. Through Jentic: under 1 hour — search, load schema, execute.

FAQs

Specific to using Airship REST API through Jentic.

Why is there no official OpenAPI spec for Airship REST API?

Airship does not publish a single OpenAPI specification for its REST API. Jentic generates and maintains this spec so that AI agents and developers can call Airship REST API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Airship REST API use?

Airship uses HTTP Basic auth: the username is the Airship app key and the password is the master secret. Through Jentic, both values are stored encrypted and the Authorization header is constructed at execution time so the master secret never enters the agent context.

Can I send a push to a specific named user?

Yes. POST /push with an audience selector of { 'named_user': '<user_id>' } targets every channel associated with that named-user ID. Use POST /named_users/associate first to link channels to the user.

What are the rate limits for the Airship REST API?

Airship applies per-app rate limits in the range of hundreds of requests per second for push and lower for management endpoints. Exact limits vary by plan; consult docs.airship.com. Treat HTTP 429 as a backoff-and-retry signal.

How do I send a push notification through Jentic?

Install with pip install jentic, search for 'send a push notification', load the Airship POST /push operation, and execute with the audience and notification fields. Jentic injects the Basic auth header at execution time.

Can I validate a push payload before sending it?

Yes. POST /push/validate runs the same validation as POST /push without dispatching to devices. Useful in CI pipelines and during template iteration to catch malformed audience selectors or platform overrides early.

Airship REST API

Connect the Airship REST API to your agent

Capabilities

Start building with Airship REST API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs