Tracking

Tracking subscription management endpoints

List tracking subscriptions

GET

https://api.openpaws.ai

/v1/tracking/subscriptions

List all tracking subscriptions owned by the authenticated user, including both active and paused subscriptions.

No metering — subscription CRUD is free. Research execution is metered via n8n.

List tracking subscriptions › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

List tracking subscriptions › Responses

List of subscriptions

object[]

total

integer

GET/v1/tracking/subscriptions

curl --request GET \
  --url https://api.openpaws.ai/v1/tracking/subscriptions \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "user_id": "00000000-0000-0000-0000-000000000000",
      "topics": [
        "string"
      ],
      "custom_keywords": [
        "string"
      ],
      "frequency": "daily",
      "specific_interests": "specific_interests",
      "delivery_email": "delivery_email",
      "delivery_method": "delivery_method",
      "active": true,
      "last_sent_at": "2024-08-25T15:00:00Z",
      "created_at": "2024-08-25T15:00:00Z",
      "updated_at": "2024-08-25T15:00:00Z"
    }
  ],
  "total": 0
}

json

application/json

Create tracking subscription

POST

https://api.openpaws.ai

/v1/tracking/subscriptions

Create a new tracking subscription to monitor animal advocacy topics. You will receive periodic email updates at the specified frequency with research findings.

No metering — subscription CRUD is free. Research execution is metered via n8n.

Create tracking subscription › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Create tracking subscription › Request Body

At least one of topics or custom_keywords is required

topics

string[]

Topic IDs to monitor (e.g., factory-farming, legislation, wildlife)

custom_keywords

string[]

Custom keywords to track

frequency

string · enum

How often to receive updates

Enum values:

daily

weekly

realtime

Default: daily

specific_interests

string · maxLength: 1000

Additional context for the research agent

delivery_email

string · email

Email address for update delivery

delivery_method

string

Delivery channel (currently only email)

Default: email

Create tracking subscription › Responses

Subscription created

object

POST/v1/tracking/subscriptions

curl --request POST \
  --url https://api.openpaws.ai/v1/tracking/subscriptions \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "topics": [
    "legislation",
    "factory-farming"
  ],
  "frequency": "weekly",
  "custom_keywords": [
    "cage-free",
    "ag-gag"
  ],
  "specific_interests": "US federal and state legislation affecting farmed animals",
  "delivery_email": "[email protected]"
}
'

shell

Example Request Body

{
  "topics": [
    "legislation",
    "factory-farming"
  ],
  "frequency": "weekly",
  "custom_keywords": [
    "cage-free",
    "ag-gag"
  ],
  "specific_interests": "US federal and state legislation affecting farmed animals",
  "delivery_email": "[email protected]"
}

json

application/json

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "user_id": "00000000-0000-0000-0000-000000000000",
    "topics": [
      "string"
    ],
    "custom_keywords": [
      "string"
    ],
    "frequency": "daily",
    "specific_interests": "specific_interests",
    "delivery_email": "delivery_email",
    "delivery_method": "delivery_method",
    "active": true,
    "last_sent_at": "2024-08-25T15:00:00Z",
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Delete tracking subscription

DELETE

https://api.openpaws.ai

/v1/tracking/subscriptions/{id}

Permanently delete a tracking subscription and all associated results.

No metering — subscription CRUD is free. Research execution is metered via n8n.

Delete tracking subscription › path Parameters

id

string · uuid · required

Subscription ID

Delete tracking subscription › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Delete tracking subscription › Responses

Subscription deleted

deleted

boolean

Update tracking subscription

PATCH

https://api.openpaws.ai

/v1/tracking/subscriptions/{id}

Update a tracking subscription. Only the fields provided in the request body are updated. Use active: false to pause and active: true to resume.

No metering — subscription CRUD is free. Research execution is metered via n8n.

Update tracking subscription › path Parameters

id

string · uuid · required

Subscription ID

Update tracking subscription › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Update tracking subscription › Request Body

topics

string[]

custom_keywords

string[]

frequency

string · enum

Enum values:

daily

weekly

realtime

specific_interests

string

delivery_email

string · email

delivery_method

string

active

boolean

Update tracking subscription › Responses

Subscription updated

object

PATCH/v1/tracking/subscriptions/{id}

curl --request PATCH \
  --url https://api.openpaws.ai/v1/tracking/subscriptions/:id \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "topics": [
    "string"
  ],
  "custom_keywords": [
    "string"
  ],
  "frequency": "daily",
  "specific_interests": "specific_interests",
  "delivery_email": "[email protected]",
  "delivery_method": "delivery_method",
  "active": true
}
'

shell

Example Request Body

{
  "topics": [
    "string"
  ],
  "custom_keywords": [
    "string"
  ],
  "frequency": "daily",
  "specific_interests": "specific_interests",
  "delivery_email": "[email protected]",
  "delivery_method": "delivery_method",
  "active": true
}

json

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "user_id": "00000000-0000-0000-0000-000000000000",
    "topics": [
      "string"
    ],
    "custom_keywords": [
      "string"
    ],
    "frequency": "daily",
    "specific_interests": "specific_interests",
    "delivery_email": "delivery_email",
    "delivery_method": "delivery_method",
    "active": true,
    "last_sent_at": "2024-08-25T15:00:00Z",
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Research

List tracking subscriptions

GET

https://api.openpaws.ai

/v1/tracking/subscriptions

List all tracking subscriptions owned by the authenticated user, including both active and paused subscriptions.

No metering — subscription CRUD is free. Research execution is metered via n8n.

List tracking subscriptions › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

List tracking subscriptions › Responses

List of subscriptions

object[]

total

integer

Create tracking subscription

POST

https://api.openpaws.ai

/v1/tracking/subscriptions

Create a new tracking subscription to monitor animal advocacy topics. You will receive periodic email updates at the specified frequency with research findings.

No metering — subscription CRUD is free. Research execution is metered via n8n.

Create tracking subscription › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Create tracking subscription › Request Body

At least one of topics or custom_keywords is required

topics

string[]

Topic IDs to monitor (e.g., factory-farming, legislation, wildlife)

custom_keywords

string[]

Custom keywords to track

frequency

string · enum

How often to receive updates

Enum values:

daily

weekly

realtime

Default: daily

specific_interests

string · maxLength: 1000

Additional context for the research agent

delivery_email

string · email

Email address for update delivery

delivery_method

string

Delivery channel (currently only email)

Default: email

Create tracking subscription › Responses

Subscription created

object

Delete tracking subscription

DELETE

https://api.openpaws.ai

/v1/tracking/subscriptions/{id}

Permanently delete a tracking subscription and all associated results.

No metering — subscription CRUD is free. Research execution is metered via n8n.

Delete tracking subscription › path Parameters

id

string · uuid · required

Subscription ID

Delete tracking subscription › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Delete tracking subscription › Responses

Subscription deleted

deleted

boolean

Update tracking subscription

PATCH

https://api.openpaws.ai

/v1/tracking/subscriptions/{id}

Update a tracking subscription. Only the fields provided in the request body are updated. Use active: false to pause and active: true to resume.

No metering — subscription CRUD is free. Research execution is metered via n8n.

Update tracking subscription › path Parameters

id

string · uuid · required

Subscription ID

Update tracking subscription › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Update tracking subscription › Request Body

topics

string[]

custom_keywords

string[]

frequency

string · enum

Enum values:

daily

weekly

realtime

specific_interests

string

delivery_email

string · email

delivery_method

string

active

boolean

Update tracking subscription › Responses

Subscription updated

object