Hive Civilization · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Thehiveryiq Com Evaluator API
12 actions
12 updates
phrasing
extends
openapi/thehiveryiq-com-evaluator-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.
What the actions change
x-apievangelist-phrasing
Targets 12
$.info
$.paths['/v1/evaluator/status'].get
$.paths['/v1/evaluator/abi'].get
$.paths['/v1/evaluator/recent_jobs'].get
$.paths['/v1/evaluator/economics'].get
$.paths['/v1/evaluator/manual_evaluate'].post
$.paths['/v1/evaluator/start'].post
$.paths['/v1/evaluator/stop'].post
$.paths['/v1/evaluator/fees'].get
$.paths['/v1/evaluator/jobs'].post
$.paths['/v1/evaluator/jobs/{job_id}'].get
$.paths['/v1/evaluator/jobs/{job_id}/attest'].post
OpenAPI Overlay
# 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 Evaluator API
version: 1.0.0
extends: openapi/thehiveryiq-com-evaluator-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: 11
- target: $.paths['/v1/evaluator/status'].get
update:
x-apievangelist-phrasing:
intent: Check the ERC-8183 evaluator listener state
effect: read
questions:
- Is the ERC-8183 evaluator listener currently running?
- What state is the evaluator's background listener in?
instructions:
- text: Show the evaluator listener status.
- text: Check whether the ERC-8183 evaluator is listening.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/evaluator/abi'].get
update:
x-apievangelist-phrasing:
intent: Get the evaluator contract ABI summary
effect: read
questions:
- What does the ERC-8183 evaluator contract ABI look like?
- Which contract functions and events does the evaluator expose?
instructions:
- text: Get the ERC-8183 evaluator ABI summary.
- text: Show me the evaluator ABI so I can wire my contract calls.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/evaluator/recent_jobs'].get
update:
x-apievangelist-phrasing:
intent: List recently evaluated jobs
effect: read
questions:
- Which jobs has the evaluator scored most recently?
- Can I limit how many recent evaluations come back?
instructions:
- text: List the {limit} most recently evaluated jobs.
slots:
limit: query.limit
- text: Show recent evaluator job results.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/evaluator/economics'].get
update:
x-apievangelist-phrasing:
intent: See evaluator fee and x402 rail wiring
effect: read
questions:
- How are evaluator fees wired to x402 payment rails?
- Where do evaluator economics and settlement rails get described?
instructions:
- text: Show the evaluator economics and x402 rail wiring.
- text: Explain how evaluator fees flow over x402.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/evaluator/manual_evaluate'].post
update:
x-apievangelist-phrasing:
intent: Manually trigger evaluation of a job
effect: write
questions:
- Can I force an evaluation without waiting for an on-chain JobSubmitted event?
- What admin credentials does a manual evaluation need?
instructions:
- text: Manually evaluate job {job_id} from provider {provider}.
slots:
job_id: requestBody.job_id
provider: requestBody.provider
- text: Synthesize a JobSubmitted event for job {job_id} by {provider} with deliverable {deliverable} and evaluate it.
slots:
job_id: requestBody.job_id
provider: requestBody.provider
deliverable: requestBody.deliverable
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/evaluator/start'].post
update:
x-apievangelist-phrasing:
intent: Start the evaluator background listener
effect: write
questions:
- How do I turn on the evaluator's background event listener?
- Is starting the evaluator listener limited to dev-trust callers?
instructions:
- text: Start the evaluator background listener.
- text: Start the listener using admin key {admin_key}.
slots:
admin_key: header.X-Admin-Api-Key
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/evaluator/stop'].post
update:
x-apievangelist-phrasing:
intent: Stop the evaluator background listener
effect: write
questions:
- How do I shut down the evaluator's background listener?
- Can I pause the ERC-8183 event listener in a dev environment?
instructions:
- text: Stop the evaluator background listener.
- text: Stop the listener using admin key {admin_key}.
slots:
admin_key: header.X-Admin-Api-Key
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/evaluator/fees'].get
update:
x-apievangelist-phrasing:
intent: Get the public evaluator fee schedule
effect: read
questions:
- What basis-point fee does the evaluator charge per complexity tier?
- How much does it cost to have a job evaluated at each tier?
instructions:
- text: Show the evaluator fee schedule by tier.
- text: List evaluator fees in basis points.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/evaluator/jobs'].post
update:
x-apievangelist-phrasing:
intent: Submit an ERC-8183 job for evaluation
effect: write
questions:
- How do I submit a job for evaluation and find out the fee and settlement recipient?
- Can I choose which chain a submitted job settles on?
instructions:
- text: Submit job {job_id} from client {client} to provider {provider} at tier {tier} worth {job_value_usdc_atomic} atomic USDC.
slots:
job_id: requestBody.job_id
client: requestBody.client
provider: requestBody.provider
tier: requestBody.tier
job_value_usdc_atomic: requestBody.job_value_usdc_atomic
- text: 'Register job {job_id} on {chain}: client {client}, provider {provider}, tier {tier}, value {job_value_usdc_atomic}.'
slots:
job_id: requestBody.job_id
chain: requestBody.chain
client: requestBody.client
provider: requestBody.provider
tier: requestBody.tier
job_value_usdc_atomic: requestBody.job_value_usdc_atomic
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/evaluator/jobs/{job_id}'].get
update:
x-apievangelist-phrasing:
intent: Check an evaluation job's lifecycle state
effect: read
questions:
- Where is my submitted job in the six-state evaluation lifecycle?
- Has a particular job been settled or rejected yet?
instructions:
- text: Get the status of evaluation job {job_id}.
slots:
job_id: path.job_id
- text: Tell me whether job {job_id} has settled.
slots:
job_id: path.job_id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/evaluator/jobs/{job_id}/attest'].post
update:
x-apievangelist-phrasing:
intent: Post a deliverable attestation for a job
effect: write
questions:
- As a provider, how do I attest my deliverable so the job gets scored?
- What happens after a deliverable attestation is posted for a job?
instructions:
- text: Attest deliverable {deliverable} for job {job_id} as provider {provider}.
slots:
deliverable: requestBody.deliverable
job_id: path.job_id
provider: requestBody.provider
- text: Post provider {provider}'s attestation on job {job_id} with deliverable {deliverable} and have it scored.
slots:
provider: requestBody.provider
job_id: path.job_id
deliverable: requestBody.deliverable
method: generated
generated: '2026-09-26'