The complete Agent Push Kit REST API. Application event ingestion uses an organization key beginning with apk_. Authenticated user operations accept either an Agent Push Kit login JWT or an agent access token beginning with apt_.
This API client was generated by the OpenAPI Generator project. By using the OpenAPI spec from a remote server, you can easily generate an API client.
Install the dependencies
install.packages("jsonlite")
install.packages("httr")
install.packages("base64enc")
git clone https://github.com/JustinBStrong/agent-push-kit-r
cd agent-push-kit-r
R CMD build .
R CMD check agentpushkit_0.1.0.tar.gz --no-manual
R CMD INSTALL --preclean agentpushkit_0.1.0.tar.gz
install.packages("agentpushkit")
To install directly from Github, use devtools:
install.packages("devtools")
library(devtools)
install_github("JustinBStrong/agent-push-kit-r")
To install the package from a local file:
install.packages("agentpushkit_0.1.0.tar.gz", repos = NULL, type = "source")
library(agentpushkit)
To reformat code using styler, please run the following in the R console:
install.packages("remotes")
remotes::install_github("r-lib/styler@v1.7.0.9003")
library("styler")
style_dir()
All URIs are relative to https://api.chatdna.co/agent-push-kit/v1
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AccountApi | DeleteCurrentAccount | DELETE /me | Delete the current user and customer accounts they own |
| AccountApi | GetCurrentAccount | GET /me | Get the current user and customer accounts |
| AgentTokensApi | CallMcp | POST /mcp | Connect through stateless MCP Streamable HTTP |
| AgentTokensApi | CreateAgentToken | POST /agent-tokens | Create a named non-expiring agent token |
| AgentTokensApi | ListAgentTokens | GET /agent-tokens | List agent access tokens without their secrets |
| AgentTokensApi | RevokeAgentToken | DELETE /agent-tokens/{tokenId} | Revoke one of the current user's agent tokens |
| AuthenticationApi | CompletePasswordReset | POST /auth/password-reset/complete | Choose a new password and log in |
| AuthenticationApi | LoginWithApple | POST /auth/apple | Log in or attach an account using a Sign in with Apple identity token |
| AuthenticationApi | LoginWithGoogle | POST /auth/google | Log in or attach an account using a verified Google ID token |
| AuthenticationApi | LoginWithPassword | POST /auth/login | Log in with email and password |
| AuthenticationApi | Register | POST /auth/register | Create a user and first customer account |
| AuthenticationApi | RequestPasswordReset | POST /auth/password-reset/request | Email a single-use password reset token |
| CustomerAccountsApi | AddOrganizationMember | POST /organizations/{organizationId}/members | Add an already-registered user to a customer account |
| CustomerAccountsApi | CreateOrganization | POST /organizations | Create another Agent Push Kit customer account |
| CustomerAccountsApi | ListOrganizationMembers | GET /organizations/{organizationId}/members | List members of a customer account |
| CustomerAccountsApi | ListOrganizations | GET /organizations | List customer accounts available to the current user |
| CustomerAccountsApi | RegenerateOrganizationApiKey | POST /organizations/{organizationId}/api-key/regenerate | Rotate the application event-ingestion key |
| DevicesApi | GetWebPushConfiguration | GET /web-push/configuration | Get browser push availability and its public VAPID key |
| DevicesApi | RegisterDevice | POST /devices | Register or refresh an APNs device |
| DevicesApi | RegisterWebPushSubscription | POST /web-push/subscriptions | Register or refresh a browser push subscription |
| DevicesApi | RemoveDevice | DELETE /devices/{installationId} | Disable push delivery to one installation |
| DevicesApi | RemoveWebPushSubscription | DELETE /web-push/subscriptions/{subscriptionId} | Disable a browser push subscription |
| EventsApi | GetEvent | GET /organizations/{organizationId}/events/{eventId} | Get one event including metadata |
| EventsApi | ListEvents | GET /organizations/{organizationId}/events | List a paginated inbox |
| EventsApi | ListNotificationTypes | GET /organizations/{organizationId}/types | List distinct notification types |
| EventsApi | ListServices | GET /organizations/{organizationId}/services | List services discovered from ingested events |
| EventsApi | SearchEvents | POST /organizations/{organizationId}/events/search | Search events with a validated Boolean filter tree |
| EventsApi | SendEvent | POST /events | Send an event using an application ingestion key |
| EventsApi | SendEventAsUser | POST /organizations/{organizationId}/events | Send an event as an authenticated user or agent |
| HealthApi | GetHealth | GET /health | Check Agent Push Kit API health |
| PreferencesApi | ListPreferences | GET /organizations/{organizationId}/preferences | List service defaults and exact-type overrides |
| PreferencesApi | RemoveTypePreference | DELETE /services/{serviceId}/types/{type}/preference | Remove an exact-type override so it inherits the service default |
| PreferencesApi | SetServicePreference | PUT /services/{serviceId}/preference | Enable or disable pushes for a service by default |
| PreferencesApi | SetTypePreference | PUT /services/{serviceId}/types/{type}/preference | Override push delivery for one exact notification type |
Authentication schemes defined for the API: