Page metadata
page_metadataTitle, description, OG/Twitter, and JSON-LD for a URL. Savings are compared with the page's visible text, not its HTML. Not for reading the page.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Public http or https page. | |
| max_sats | No | Most this call may charge. Minimum 1. A higher total charges nothing. | |
| include_text | No | Off by default. Set true to include plain page text. | |
| include_links | No | Off by default. Set true to include up to 40 http links. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| code | No | approval_required, limit_exceeded, or insufficient_balance when the call stopped. | |
| which | No | Which limit: per_call, per_day, per_session, per_hour_buys, per_minute_calls, or per_minute_sats. | |
| content | No | Delivered text. Empty when the call did not deliver. | |
| message | No | ||
| order_id | No | Order id after a charge. Null when nothing was charged. | |
| truncated | No | True when the source was longer than content, or the page itself was cut. | |
| total_cost | No | All-in price string. | |
| approval_url | No | Page where the person approves this exact price. | |
| balance_sats | No | Credit balance after the call, or null when it was not read. | |
| sats_charged | No | Sats charged for this call. 0 when nothing was charged. | |
| total_length | No | Characters before truncation. Larger than content_length when truncated is true. | |
| content_length | No | Characters in content. |