pdf-text

Mint a caller key (POST /keys). Bot install starts at GET https://pdf.kymac.co/llms.txt (sole advertised entry). Secret ssm_… is returned once. Prefer Authorization: Bearer; X-API-Key is an alias. First issue grants 1 free credit (credit.grant reason=first_key). Quote cost with quote_credits before pdf_extract.

{
  "type": "object",
  "properties": {}
}

Confirm PDF_TEXT_API_KEY or Authorization: Bearer (GET /keys/verify). X-API-Key is an alias only. Does not echo the secret.

{
  "type": "object",
  "properties": {}
}

Replace the presented secret (POST /keys/rotate). Same id/caller_id and credits. New ssm_… is returned once. Old secret then fails 401 invalid_api_key. Prefer Authorization: Bearer; X-API-Key is an alias only. No ops file-edit.

{
  "type": "object",
  "properties": {}
}

Invalidate the presented secret (POST /keys/revoke). Same id is revoked; old secret then fails 401 invalid_api_key. Prefer Authorization: Bearer; X-API-Key is an alias only. No ops file-edit.

{
  "type": "object",
  "properties": {}
}

Prepaid TEST packs (GET /credits/packs). checkout_credits is intent only; credits grant after confirm_credits.

{
  "type": "object",
  "properties": {}
}

Stripe TEST PaymentIntent for a pack (POST /credits/checkout). Intent only — returns credits_pending; credits are not granted or spendable until confirm_credits succeeds. Requires a caller key.

{
  "type": "object",
  "properties": {
    "pack_id": {
      "type": "string",
      "description": "Pack id from list_credit_packs (e.g. pack_10)."
    }
  },
  "required": [
    "pack_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Confirm a TEST PaymentIntent with Stripe test card pm_card_visa (POST /credits/confirm). This is when credits become granted/spendable (appends credit.purchase with credits_added). TEST only.

{
  "type": "object",
  "properties": {
    "stripe_payment_intent_id": {
      "type": "string",
      "description": "PaymentIntent id (pi_…) from checkout_credits."
    }
  },
  "required": [
    "stripe_payment_intent_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Dry-run cost for an op without debit (GET /credits/quote?op=pdf). Returns cost, balance, and would_succeed.

{
  "type": "object",
  "properties": {
    "op": {
      "description": "Operation to quote. Defaults to pdf.",
      "type": "string"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Derived prepaid balance for this caller_id (GET /credits/balance).

{
  "type": "object",
  "properties": {}
}

Append-only Ledger events for this caller_id (GET /credits/events): credit.grant (first_key), credit.purchase, credit.debit (pdf_success), optional credit.balance_snapshot.

{
  "type": "object",
  "properties": {}
}

Text-layer PDF extract (POST /pdf). Install via GET https://pdf.kymac.co/llms.txt only. Prefer Authorization: Bearer; X-API-Key is an alias. Golden URL https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf — compare ok true/false JSON in llms.txt. First key includes 1 free credit. Quote first with quote_credits (no debit). Debits 1 credit on ok:true (credit.debit reason=pdf_success). 200 bodies include credits_burned and credits_remaining. HTTP fails use code/message/retryable/next (error aliases message). 401 next=refresh key. 402: code=insufficient_credits, retryable=false, next=buy credits. Retryable fails use next=retry. No OCR.

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "Absolute http(s) URL of a text-layer PDF. Golden proof URL: https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf"
    }
  },
  "required": [
    "url"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Public readiness (GET /health): billing (test|gated) and runner_ready. No key.

{
  "type": "object",
  "properties": {}
}