Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com Xcalibur API

7 actions 7 updates phrasing extends openapi/thehiveryiq-com-xcalibur-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Hive Civilization's API. It is a proposal applied on top of the contract, not a document Hive Civilization publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/v1/xcalibur/echo/v2/compress'].post
$.paths['/v1/xcalibur/echo/v2/health'].get
$.paths['/v1/xcalibur/membrane/v2/classify'].post
$.paths['/v1/xcalibur/membrane/v2/health'].get
$.paths['/v1/xcalibur/verify/v2/attest'].post
$.paths['/v1/xcalibur/verify/v2/health'].get

OpenAPI Overlay

Raw ↑
# 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 Xcalibur API
  version: 1.0.0
extends: openapi/thehiveryiq-com-xcalibur-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: 6
- target: $.paths['/v1/xcalibur/echo/v2/compress'].post
  update:
    x-apievangelist-phrasing:
      intent: Compress a prompt with ECHO v2
      effect: write
      questions:
      - Can I shrink a long prompt while keeping what matters for my task?
      - How do I set a target compression ratio and a minimum preservation score?
      instructions:
      - text: 'Compress this prompt with ECHO: {prompt}.'
        slots:
          prompt: requestBody.prompt
      - text: Compress {prompt} to ratio {target_ratio} for the task {task_query}.
        slots:
          prompt: requestBody.prompt
          target_ratio: requestBody.target_ratio
          task_query: requestBody.task_query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/xcalibur/echo/v2/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check ECHO v2 compressor health
      effect: read
      questions:
      - Is the ECHO v2 prompt compressor up?
      - Can I health-check the compression endpoint before sending prompts?
      instructions:
      - text: Check ECHO v2 compressor health.
      - text: Ping the prompt compression service.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/xcalibur/membrane/v2/classify'].post
  update:
    x-apievangelist-phrasing:
      intent: Classify text as safe or unsafe
      effect: read
      questions:
      - How do I check whether a piece of text is a prompt injection or otherwise unsafe?
      - Can I adjust the threshold and per-model weights of the MEMBRANE safety ensemble?
      - Does the safety verdict come with a signed receipt?
      instructions:
      - text: Classify {text} as safe or unsafe.
        slots:
          text: requestBody.text
      - text: Run MEMBRANE on {text} with an unsafe threshold of {threshold}.
        slots:
          text: requestBody.text
          threshold: requestBody.threshold
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/xcalibur/membrane/v2/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check MEMBRANE v2 classifier health
      effect: read
      questions:
      - Is the MEMBRANE safety classifier available?
      - Can I health-check MEMBRANE without loading its models?
      instructions:
      - text: Check MEMBRANE v2 health.
      - text: Ping the safety classifier service.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/xcalibur/verify/v2/attest'].post
  update:
    x-apievangelist-phrasing:
      intent: Attest a data chunk belongs to a signed corpus
      effect: read
      questions:
      - How do I prove a chunk is in a corpus and was signed by a specific post-quantum key?
      - Which signature algorithms does the attestation ensemble cross-check?
      instructions:
      - text: Attest chunk {chunk} against corpus root {corpus_root} with signature {signature_hex} and key {signer_pubkey_hex}.
        slots:
          chunk: requestBody.chunk
          corpus_root: requestBody.corpus_root
          signature_hex: requestBody.signature_hex
          signer_pubkey_hex: requestBody.signer_pubkey_hex
      - text: Verify {chunk} is under root {corpus_root} via path {expected_path}, signed {signature_hex} by {signer_pubkey_hex}.
        slots:
          chunk: requestBody.chunk
          corpus_root: requestBody.corpus_root
          expected_path: requestBody.expected_path
          signature_hex: requestBody.signature_hex
          signer_pubkey_hex: requestBody.signer_pubkey_hex
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/xcalibur/verify/v2/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check VERIFY v2 attestation health
      effect: read
      questions:
      - Is the VERIFY v2 corpus attestation endpoint up?
      - Can I health-check attestation without loading the PQ libraries?
      instructions:
      - text: Check VERIFY v2 attestation health.
      - text: Ping the corpus attestation service.
      method: generated
      generated: '2026-09-26'