URL: news-hook.southamerica-east1.run.app

You can try the API with: news-hook.southamerica-east1.run.app/docs

X-API-Key header is required for all endpoints, except for the /llm-models endpoint

POST
/alerts
Create alert request
Prompt
stringrequired

Description of the event or condition to be monitored. The alert request is sent via HTTP request

http_method
enumrequired

HTTP method to be used when sending the alert request

Available options:POST, PATCH, PUT
http_url
stringrequired

URL to be used when sending the alert request

http_headers
object

HTTP headers to be used when sending the alert request

is_recurring
booleanrequired

Should we send the alert every time the condition is met?

llm_model
string
Default:gemini-2.5-pro-preview-05-06

The model to be used for validating the alert request and generating the alerts' payload

Available options:gemini-2.5-pro-preview-05-06, gemini-2.5-flash-preview-05-20, gemini-2.0-flash-lite-001, gemini-2.0-flash-001
payload_format
object
Default:An OpenAPI 3.0 Specification of an object with title and description

The body of the request. Must be in OpenAPI 3.0 Specification format

max_datetime
datetime
Default:+300 days

The expiration date of the alert request

GET
/alerts
List all alerts within the filters
offset
number
Default:0

The offset of the alert requests to return

range:min: 0
limit
number
Default:50

The limit number of alert requests to return

range:min: 1 | max: 100
prompt_contains
string

Substring that must be contained in the alert request's prompt

created_after
datetime

The earliest datetime the alert was created at

max_datetime
datetime
Default:now

The latest datetime the alert was created at

PATCH
/alerts/{alert_id}/cancel
Marks the alert request with the given 'id' as 'cancelled'. Does not delete it (for billing purposes)
alert_id
stringrequired

The ID of the alert request to cancel

GET
/llm-models
List all LLM models available for the alert requests
POST
/user_documents
Send a text to trigger any matching alert requests.\nIt's like sending a .txt file
name
stringrequired

The name of the text

range:min: 3
content
stringrequired

The content of the text

range:min: 10
GET
/user_documents/{document_id}
Get user document with the given ID
document_id
stringrequired

The ID of the user document to get

GET
/events
List all alert events ever triggered
offset
number
Default:0

The offset of the alert events to return

range:min: 0
limit
number
Default:50

The limit of the alert events to return

range:min: 1 | max: 100
triggered_before
datetime

The earliest datetime the alert events were triggered at

triggered_after
datetime
Default:now

The latest datetime the alert events were triggered at

GET
/alerts/{alert_id}
Get alert request with the given ID
alert_id
stringrequired

The ID of the alert request to get

GET
/credits
Check how many credits you have