Pocketping API Documentation

The Pocketping API allows you to send SMS notifications that are automatically summarized and filtered using AI technology. This page explains how to use the API and provides examples in various programming languages.

Authentication

To use the Pocketping API, you need an API key. You can find your API key in your dashboard. Include this key in the Apikey header as a Bearer token.

Endpoint

The endpoint for sending SMS notifications is:

POST https://pocketping.app/api/v1/ping

Request Format

The API accepts JSON payloads. Here's the structure of a valid request:

{
  "sms": "Your full notification message goes here.",
  "ai_assistant": true
}

Set ai_assistant to true to enable AI summarization and filtering.

Headers

Include the following header with your request:

• Content-Type: application/json
• Apikey: Bearer your_api_key

Response

The API will respond with a JSON object containing information about the processed notification:

{
  "title": "AI-generated title",
  "message": "AI-generated summary message",
  "relevance_value": 75
}

Examples

Here are examples of how to use the Pocketping API in different programming languages:

curl -X POST \
  'https://pocketping.app/api/v1/ping' \
  -H 'Content-Type: application/json' \
  -H 'Apikey: Bearer your_api_key' \
  -d '{
    "sms": "Your package has been delivered.",
    "ai_assistant": true
  }'

Rate Limiting

The API has a rate limit based on your subscription plan. You can check your remaining requests in the API response or in your dashboard.

Error Handling

If an error occurs, the API will return an appropriate HTTP status code along with a JSON response containing error details:

{
  "error": "Error message describing what went wrong"
}