Authorization: Bearer pmcp_...
Authorization: Bearer <OAuth access token>

Returns the account associated with the API key.

{}

curl https://api.pinglymcp.com/account \
  -H "Authorization: Bearer $PINGLYMCP_API_KEY"

Returns the same shared service definitions used to build the MCP tool schemas and the documentation below.

{}

Ping

Check public IPv4 addresses, IPv6 addresses, and domain names for network reachability. Costs 0 credits.

Response: Success returns ok, data.request, data.ping, and meta. Errors use stable product codes, retry guidance, and a request ID.

{
  "target": "example.com"
}

curl -X POST https://api.pinglymcp.com/ping \
  -H "Authorization: Bearer $PINGLYMCP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"target":"example.com"}'

Describe Website

Render a public website, capture its viewport before AI analysis, and return a description, screenshot URL, and visible navigation links. Costs 1 credits.

Response: Success returns ok, data.request, data.page (requested/resolved URLs, title, screenshot), data.analysis, data.content, data.navigation, and meta. The screenshot URL is public to anyone with the link and expires after seven days. data.page.screenshot is null if capture or storage fails. data.navigation.links contains up to 12 visible links; data.navigation is null if the scan fails. Links are reported, not visited. Errors return ok: false, error (code, message, retryable, optional details), and meta.

{
  "url": "https://example.com"
}

curl -X POST https://api.pinglymcp.com/website/describe \
  -H "Authorization: Bearer $PINGLYMCP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","instruction":"Focus on the navigation and primary call to action."}'

Contact Website

Contact a website owner from a public URL by email or contact form, with optional AI-assistance for difficult form workflows. Costs 1 credits when completed without AI, or 10 credits when AI assistance is used.

Response: Success returns ok, data.request (effective contact values), data.page (requested/target URLs and optional screenshot), data.contact (method, status, submission, verification, confirmation), and meta (billing and safe debug summary). Email results additionally include data.contact.email with from (effective From address), replyTo (effective Reply-To address, or null when no header was sent), and status: accepted. Accepted confirms submission to the sending service, not inbox delivery. This optional object is absent for contact forms and may be absent in older results. Errors use stable product codes and retryable flags. An unconfirmed submission is never safe to retry automatically.

{
  "url": "https://example.com/contact-us",
  "name": "Your Name",
  "email": "you@example.com",
  "subject": "Hello",
  "message": "I would like to get in touch.",
  "method": "auto",
  "use_ai": false
}

curl -X POST https://api.pinglymcp.com/contacts/send \
  -H "Authorization: Bearer $PINGLYMCP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/contact-us","name":"Your Name","email":"you@example.com","subject":"Hello","message":"I would like to get in touch.","method":"auto","use_ai":false}'

{
  "url": "https://example.com/contact-us",
  "name": "Your Name",
  "email": "you@example.com",
  "subject": "Hello",
  "message": "I would like to get in touch.",
  "method": "auto",
  "use_ai": false
}

curl -X POST https://api.pinglymcp.com/contacts/send \
  -H "Authorization: Bearer $PINGLYMCP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/contact-us","name":"Your Name","email":"you@example.com","subject":"Hello","message":"I would like to get in touch.","method":"auto","use_ai":false}'

Get billing account

Read your subscription and credits. Requires billing:read. Costs 0 credits.

{}

curl 'https://api.pinglymcp.com/billing' \
  -H "Authorization: Bearer $PINGLYMCP_API_KEY"

Get billing history

Read purchases, invoices and refunds. Requires billing:read. Costs 0 credits.

{}

curl 'https://api.pinglymcp.com/billing/history?limit=20' \
  -H "Authorization: Bearer $PINGLYMCP_API_KEY"

Create credit top-up

Create a hosted payment link to buy credits. Payment must complete before credits are granted. Requires billing:manage. Costs 0 service credits.

{
  "topUpCents": 500,
  "operationKey": "purchase-2026-09-27-001"
}

curl -X POST https://api.pinglymcp.com/billing/top-ups \
  -H "Authorization: Bearer $PINGLYMCP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"topUpCents":500,"operationKey":"purchase-2026-09-27-001"}'

Get billing operation

Check whether a billing operation requires payment, is pending, or has completed. Requires billing:read. Costs 0 credits.

{
  "operationId": "billing_operation_id"
}

curl 'https://api.pinglymcp.com/billing/operations/billing_operation_id' \
  -H "Authorization: Bearer $PINGLYMCP_API_KEY"

Create subscription checkout

Create a hosted payment link for a new subscription. Requires billing:manage. Costs 0 service credits.

{
  "plan": "developer",
  "operationKey": "purchase-2026-09-27-001"
}

curl -X POST https://api.pinglymcp.com/billing/subscriptions/checkout \
  -H "Authorization: Bearer $PINGLYMCP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"plan":"developer","operationKey":"purchase-2026-09-27-001"}'

Preview subscription change

Preview an upgrade, downgrade, cancellation at renewal, reversal of cancellation, or removal of a scheduled downgrade while keeping the current plan. Upgrades require successful payment; downgrades apply at renewal. Requires billing:manage. Costs 0 credits.

{
  "action": "upgrade"
}

curl -X POST https://api.pinglymcp.com/billing/subscriptions/preview \
  -H "Authorization: Bearer $PINGLYMCP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"action":"upgrade","plan":"developer"}'

Change subscription

Confirm an unexpired preview. May charge the saved payment method for an upgrade. Review the preview before calling. Requires billing:manage. Costs 0 service credits.

{
  "previewId": "billing_preview_id",
  "operationKey": "purchase-2026-09-27-001"
}

curl -X POST https://api.pinglymcp.com/billing/subscriptions/change \
  -H "Authorization: Bearer $PINGLYMCP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"previewId":"billing_preview_id","operationKey":"purchase-2026-09-27-001"}'

Create billing portal session

Create a private hosted link for payment methods and invoices. Share it only with the account owner. Requires billing:manage. Costs 0 credits.

{
  "operationKey": "purchase-2026-09-27-001"
}

curl -X POST https://api.pinglymcp.com/billing/portal \
  -H "Authorization: Bearer $PINGLYMCP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"operationKey":"purchase-2026-09-27-001"}'