SceniqDevelopers

check_links

Check the guide's links now.

POST/v1/guides/{productId}/links/check
MCP tool check_linksScope: writeBetaSince 2026-09-30
Markdown

Queues checks for unchecked links and links not checked in a day, or exactly the urls you pass (at most 40), or every link with all true. Results land within a minute or two; read them with get_link_report. Limited to 12 calls per guide per hour.

curl -X POST "https://sceniq.earth/api/v1/guides/j5738kd1q9x2m7v4c6b8n0p3r5t1w9y2/links/check" \
  -H "Authorization: Bearer $SCENIQ_API_KEY"

Path parameters

Body parameters

  • allbooleanoptional

    true re-checks every link, not only unchecked and stale ones.

  • urlsarray of stringsoptional

    Check exactly these links of the guide (at most 40).

Returns

200 OK with this object.

  • queuednumberrequired

    Links queued for a check.

  • totalnumberrequired

    Links of the guide.

  • productIdstring · guide idrequired

    The guide's id.

  • nextStepstringrequired

    What to do next.

Response 200
{
  "queued": 2,
  "total": 8,
  "productId": "j5738kd1q9x2m7v4c6b8n0p3r5t1w9y2",
  "nextStep": "Checks are running; read get_link_report in a minute or two."
}

Errors

Every error is { error: { code, message } }. Act on the code.

  • 400invalid_argumentA required field is missing, a field is unknown, or a value does not match its type (the Convex validator's path and value are in the message).
  • 400invalid_requestA writer refused a value: a map link on a host that is not allowed, a title that is too long, a date that does not exist, too many items in a list. The message is the writer's own sentence.
  • 401unauthenticatedThe request carries no key. Send it as Authorization: Bearer sk_sceniq_... (or X-Api-Key).
  • 401invalid_api_keyThe key is unknown, revoked or expired.
  • 403api_scope_requiredA read-only key called a write operation, or a key without the publish option called publish_changes.
  • 403forbiddenThe key belongs to a creator account that is no longer active.
  • 404not_foundThe id does not exist or belongs to another creator. The two answers are identical on purpose, so ids never reveal what exists.
  • 413payload_too_largeA JSON body over 2 MB, an image over 6 MB, a batch upload over 19 MB, or an MCP message over 2 MB.
  • 429rate_limitedOver a limit: requests per key per minute, per creator per hour, uploads per key per minute, or check_links per guide per hour.
  • 500internal_errorAn unexpected failure. The message is hidden on purpose.