# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Thehiveryiq Com Deedlock API
  version: 1.0.0
extends: openapi/thehiveryiq-com-deedlock-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 14
- target: $.paths['/v1/deedlock/mcp'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Deedlock MCP server metadata
      effect: read
      questions:
      - What does the Deedlock MCP endpoint advertise about itself?
      - Is there an MCP server for real-estate deed attestations I can connect an agent to?
      instructions:
      - text: Fetch the Deedlock MCP metadata.
      - text: Describe the Deedlock MCP endpoint before I connect my agent.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/deedlock/mcp'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a request to the Deedlock MCP server
      effect: write
      questions:
      - Can my agent call Deedlock tools over MCP instead of the REST routes?
      - Where do I POST MCP messages for the Deedlock deed service?
      instructions:
      - text: Send an MCP request to the Deedlock server.
      - text: Invoke a Deedlock tool through the MCP endpoint.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/deedlock/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check Deedlock service health
      effect: read
      questions:
      - Is the Deedlock deed attestation service up right now?
      - Can I run a liveness check on Deedlock before recording closings?
      instructions:
      - text: Check Deedlock health.
      - text: Confirm the Deedlock service is responding.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/deedlock/pricing'].get
  update:
    x-apievangelist-phrasing:
      intent: View Deedlock pricing
      effect: read
      questions:
      - What does Deedlock charge for deed and notary attestations?
      - Where can I see the price list for Deedlock services?
      instructions:
      - text: Show Deedlock pricing.
      - text: Get the Deedlock price list.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/deedlock/deed_attest'].post
  update:
    x-apievangelist-phrasing:
      intent: Attest a real-estate transaction event
      effect: write
      questions:
      - How do I record a signed attestation for a property closing event between a buyer and seller?
      - Can a deed attestation capture title order, escrow number and sale price?
      - Does a deed attestation flag FinCEN geographic targeting order transactions?
      instructions:
      - text: Attest event {event_type} for property {property_id} between buyer {buyer_did} and seller {seller_did} with hash {event_hash}.
        slots:
          event_type: requestBody.event_type
          property_id: requestBody.property_id
          buyer_did: requestBody.buyer_did
          seller_did: requestBody.seller_did
          event_hash: requestBody.event_hash
      - text: Record a deed attestation for {property_id}, buyer {buyer_did}, seller {seller_did}, event {event_type}, hash {event_hash}, sale price {sale_price_cents} cents.
        slots:
          property_id: requestBody.property_id
          buyer_did: requestBody.buyer_did
          seller_did: requestBody.seller_did
          event_type: requestBody.event_type
          event_hash: requestBody.event_hash
          sale_price_cents: requestBody.sale_price_cents
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/deedlock/notary_session'].post
  update:
    x-apievangelist-phrasing:
      intent: Attest a notary signing session
      effect: write
      questions:
      - Can I attest a remote online notarization session with the documents signed in it?
      - Which notary details, like journal entry and ID checks, get recorded for a signing session?
      instructions:
      - text: Attest a {notarization_type} notary session by {notary_did} for property {property_id}, buyer {buyer_did}, seller {seller_did}.
        slots:
          notarization_type: requestBody.notarization_type
          notary_did: requestBody.notary_did
          property_id: requestBody.property_id
          buyer_did: requestBody.buyer_did
          seller_did: requestBody.seller_did
      - text: Record notary journal entry {notary_journal_entry} with document hashes {document_hashes} for {property_id}.
        slots:
          notary_journal_entry: requestBody.notary_journal_entry
          document_hashes: requestBody.document_hashes
          property_id: requestBody.property_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/deedlock/recording_attest'].post
  update:
    x-apievangelist-phrasing:
      intent: Attest a deed's county recording
      effect: write
      questions:
      - How do I attest that a deed was recorded at the county, linked to the signed-deed attestation?
      - Can a recording attestation carry book, page and document number?
      instructions:
      - text: Attest recording of {property_id} in {recording_county}, {recording_state} with status {recording_status}, chained to {deed_signed_attestation_id}.
        slots:
          property_id: requestBody.property_id
          recording_county: requestBody.recording_county
          recording_state: requestBody.recording_state
          recording_status: requestBody.recording_status
          deed_signed_attestation_id: requestBody.deed_signed_attestation_id
      - text: Record the county filing for buyer {buyer_did} and seller {seller_did} on property {property_id}.
        slots:
          buyer_did: requestBody.buyer_did
          seller_did: requestBody.seller_did
          property_id: requestBody.property_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/deedlock/deed_get/{attestation_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a deed attestation
      effect: read
      questions:
      - Can I pull up the full stored record of one deed attestation by its id?
      - What was stored in a specific Deedlock attestation?
      instructions:
      - text: Get deed attestation {attestation_id}.
        slots:
          attestation_id: path.attestation_id
      - text: Show the stored record for attestation {attestation_id}.
        slots:
          attestation_id: path.attestation_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/deedlock/deed_verify/{attestation_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Verify a deed attestation's signature
      effect: read
      questions:
      - Is a given deed attestation authentic and untampered?
      - Can I check the signature on one Deedlock attestation?
      instructions:
      - text: Verify deed attestation {attestation_id}.
        slots:
          attestation_id: path.attestation_id
      - text: Check the signature of attestation {attestation_id} is valid.
        slots:
          attestation_id: path.attestation_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/deedlock/chain_verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a property's full attestation chain
      effect: read
      questions:
      - Is the chain of custody for a property complete from signing through recording?
      - Can I require the RECORDED state before a property chain counts as complete?
      instructions:
      - text: Verify the attestation chain for property {property_id}.
        slots:
          property_id: requestBody.property_id
      - text: Check the chain for {property_id} is complete and recorded with {require_recorded}.
        slots:
          property_id: requestBody.property_id
          require_recorded: requestBody.require_recorded
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/deedlock/by-property/{property_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List attestations for a property
      effect: read
      questions:
      - Which attestations exist for a given property or escrow number?
      - Can I filter a property's attestations to one buyer or seller?
      instructions:
      - text: List attestations for property {property_id}.
        slots:
          property_id: path.property_id
      - text: Show attestations on {property_id} involving buyer {buyer_did}.
        slots:
          property_id: path.property_id
          buyer_did: query.buyer_did
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/deedlock/by-buyer/{buyer_did}'].get
  update:
    x-apievangelist-phrasing:
      intent: List attestations by buyer
      effect: read
      questions:
      - Which property transactions has a particular buyer DID been part of?
      - Can I page through a buyer's attestations?
      instructions:
      - text: List attestations where {buyer_did} is the buyer.
        slots:
          buyer_did: path.buyer_did
      - text: Show the first {limit} attestations for buyer {buyer_did}.
        slots:
          limit: query.limit
          buyer_did: path.buyer_did
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/deedlock/by-seller/{seller_did}'].get
  update:
    x-apievangelist-phrasing:
      intent: List attestations by seller
      effect: read
      questions:
      - What properties has a given seller DID sold according to Deedlock?
      - Can I paginate the attestation history of a seller?
      instructions:
      - text: List attestations where {seller_did} is the seller.
        slots:
          seller_did: path.seller_did
      - text: Show {limit} seller attestations for {seller_did} starting at {offset}.
        slots:
          limit: query.limit
          seller_did: path.seller_did
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/deedlock/by-notary/{notary_did}'].get
  update:
    x-apievangelist-phrasing:
      intent: List attestations by notary
      effect: read
      questions:
      - Which closings has a specific notary DID been involved in?
      - Can I audit a notary's attestation history page by page?
      instructions:
      - text: List attestations notarized by {notary_did}.
        slots:
          notary_did: path.notary_did
      - text: Show {limit} attestations for notary {notary_did}.
        slots:
          limit: query.limit
          notary_did: path.notary_did
      method: generated
      generated: '2026-09-26'