Discover, hire, and verify real-world physical capability through MCP.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Activate an approved registration, making the operator's equipment live on the network and ready to accept jobs.
Registration ID
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
Activate an approved registration, making the operator's equipment live on the network and ready to accept jobs.
| Argument | Type | Description |
|---|---|---|
| registrationId* | string | Registration ID |
{
"type": "object",
"required": [
"registrationId"
],
"properties": {
"registrationId": {
"type": "string",
"description": "Registration ID"
}
}
}Advance the automation level for a transfer pair (manual → teleoperated → pilot_operated → vla_assisted → fully_autonomous). Requires sufficient training episodes.
| Argument | Type | Description |
|---|---|---|
| toNodeId* | string | Destination instrument node ID |
| fromNodeId* | string | Source instrument node ID |
{
"type": "object",
"required": [
"fromNodeId",
"toNodeId"
],
"properties": {
"toNodeId": {
"type": "string",
"description": "Destination instrument node ID"
},
"fromNodeId": {
"type": "string",
"description": "Source instrument node ID"
}
}
}AI analysis of machine documentation. Upload docs to get suggested capabilities, extracted specs, materials, and tolerances.
| Argument | Type | Description |
|---|---|---|
| document | string | Document content or reference to analyze |
{
"type": "object",
"required": [],
"properties": {
"document": {
"type": "string",
"description": "Document content or reference to analyze"
}
}
}Approve a submitted machine registration. Moves it from 'submitted' to 'approved' status, enabling the operator to activate and start accepting jobs.
| Argument | Type | Description |
|---|---|---|
| registrationId* | string | Registration ID (e.g. 'reg-1234567890') |
{
"type": "object",
"required": [
"registrationId"
],
"properties": {
"registrationId": {
"type": "string",
"description": "Registration ID (e.g. 'reg-1234567890')"
}
}
}Archive an encrypted evidence bundle to IPFS and store the resulting CID in the database. Idempotent — returns existing CID if already archived.
| Argument | Type | Description |
|---|---|---|
| bundleId* | string | Encrypted evidence bundle ID |
{
"type": "object",
"required": [
"bundleId"
],
"properties": {
"bundleId": {
"type": "string",
"description": "Encrypted evidence bundle ID"
}
}
}Archive an evidence bundle to IPFS/Storacha for permanent decentralized storage. Returns the content-addressed CID.
| Argument | Type | Description |
|---|---|---|
| bundle* | object | Evidence bundle object to archive |
{
"type": "object",
"required": [
"bundle"
],
"properties": {
"bundle": {
"type": "object",
"description": "Evidence bundle object to archive"
}
}
}Attach a notification/dispatch channel to an operator so PCC knows how to ping them when a job lands. The operator's onboarding agent calls this AFTER the conversation that produced the channel record. Transport is a small stable enum (webhook|email|sms|voice|push|mqtt|file|manual) — vendor specifics live in the free-form `describe` field, written by the operator's agent. PCC the substrate stays neutral. Returns the channel record with a generated id.
| Argument | Type | Description |
|---|---|---|
| slug* | string | Operator slug (typically the operator's address or unique identifier). |
| label* | string | Short human label shown to the operator and in admin UIs: 'Front counter printer', 'Owner's phone'. |
| enabled | boolean | Whether the channel is live (defaults to true). |
| describe* | string | Plain-English instructions for how PCC should talk to whatever is on the other end. Written by the operator's onboarding agent. Required, ≥4 chars. Example: 'POST JSON with keys order_id, line_items[], deadline_iso. I will POST back {order_id, status} to your reply URL.' |
| endpoint | object | Transport-specific routing payload. webhook→{url}, email→{address}, sms/voice→{phoneE164}, push→{token,platform}, mqtt→{brokerUrl,topic}, file→{scheme,path}, manual→{}. |
| direction | string | out=PCC pushes only; in-out=operator's system also replies; in=operator pushes unsolicited. |
Build and submit a capability contract with on-chain milestone escrow. Returns job ID and escrow address.
| Argument | Type | Description |
|---|---|---|
| type* | string | Capability type |
| profileId | string | Optional capability profile ID |
| selections* | object | Configuration selections |
| assuranceTier* | number | Assurance tier 0-3 (0=self-reported, 3=ZK-proven+bonds) |
{
"type": "object",
"required": [
"type",
"selections",
"assuranceTier"
],
"properties": {
"type": {
"type": "string",
"description": "Capability type"
},
"profileId": {
"type": "string",
"description": "Optional capability profile ID"
},
"selections": {
"type": "object",
"description": "Configuration selections"
},
"assuranceTier": {
"type": "number",
"description": "Assurance tier 0-3 (0=self-reported, 3=ZK-proven+bonds)"
}
}
}Calculate price for a capability configuration. Returns base price, tier premiums, and estimated total cost.
| Argument | Type | Description |
|---|---|---|
| type* | string | Capability type |
| profileId | string | Optional capability profile ID |
| selections* | object | Configuration selections (material, dimensions, quantity, etc.) |
{
"type": "object",
"required": [
"type",
"selections"
],
"properties": {
"type": {
"type": "string",
"description": "Capability type"
},
"profileId": {
"type": "string",
"description": "Optional capability profile ID"
},
"selections": {
"type": "object",
"description": "Configuration selections (material, dimensions, quantity, etc.)"
}
}
}Calculate ROI projection for onboarding equipment. Returns month-by-month revenue, cost, and break-even analysis.
| Argument | Type | Description |
|---|---|---|
| avgJobValue | number | Average revenue per job in USD |
| monthlyCost | number | Monthly operating cost in USD |
| utilization | number | Expected utilization percentage (0-100) |
{
"type": "object",
"required": [],
"properties": {
"avgJobValue": {
"type": "number",
"description": "Average revenue per job in USD"
},
"monthlyCost": {
"type": "number",
"description": "Monthly operating cost in USD"
},
"utilization": {
"type": "number",
"description": "Expected utilization percentage (0-100)"
}
}
}Cancel a protocol run. Cannot be cancelled once completed or already cancelled.
| Argument | Type | Description |
|---|---|---|
| runId* | string | Protocol run ID to cancel |
{
"type": "object",
"required": [
"runId"
],
"properties": {
"runId": {
"type": "string",
"description": "Protocol run ID to cancel"
}
}
}Validate an invite code before redeeming it. Returns whether the code is valid and what it includes.
| Argument | Type | Description |
|---|---|---|
| code* | string | Invite code to check |
{
"type": "object",
"required": [
"code"
],
"properties": {
"code": {
"type": "string",
"description": "Invite code to check"
}
}
}Check for admin replies on the operator's support threads. Call this periodically or when the operator asks 'did they respond yet?'. Returns all threads for this kernel and a hasUnreadReplies boolean indicating new admin messages.
| Argument | Type | Description |
|---|---|---|
| kernelId* | string | Operator's kernel ID |
{
"type": "object",
"required": [
"kernelId"
],
"properties": {
"kernelId": {
"type": "string",
"description": "Operator's kernel ID"
}
}
}Claim a bounty to onboard a new capability. The operator commits to registering the capability and completing verification.
| Argument | Type | Description |
|---|---|---|
| bountyId* | string | ID of the bounty to claim |
| operatorId* | string | ID of the operator claiming the bounty |
{
"type": "object",
"required": [
"bountyId",
"operatorId"
],
"properties": {
"bountyId": {
"type": "string",
"description": "ID of the bounty to claim"
},
"operatorId": {
"type": "string",
"description": "ID of the operator claiming the bounty"
}
}
}Claim earned revenue from an IP asset vault. Returns the claimed amount and transaction hash.
| Argument | Type | Description |
|---|---|---|
| ipId* | string | IP asset ID |
| tokenIds | array | Specific royalty token IDs to claim (optional — claims all if omitted) |
{
"type": "object",
"required": [
"ipId"
],
"properties": {
"ipId": {
"type": "string",
"description": "IP asset ID"
},
"tokenIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specific royalty token IDs to claim (optional — claims all if omitted)"
}
}
}Operator claims an investment pool reward after capability verification.
| Argument | Type | Description |
|---|---|---|
| poolId* | string | Pool ID to claim |
| operatorId* | string | Operator ID making the claim |
{
"type": "object",
"required": [
"poolId",
"operatorId"
],
"properties": {
"poolId": {
"type": "string",
"description": "Pool ID to claim"
},
"operatorId": {
"type": "string",
"description": "Operator ID making the claim"
}
}
}Close an investment pool to new stakes. Pool enters sunset phase.
| Argument | Type | Description |
|---|---|---|
| poolId* | string | Pool ID to close |
{
"type": "object",
"required": [
"poolId"
],
"properties": {
"poolId": {
"type": "string",
"description": "Pool ID to close"
}
}
}Create a Merkle commitment for an evidence bundle hash. Used as the first step in ZK proof generation for Tier 3 assurance.
| Argument | Type | Description |
|---|---|---|
| bundleHash* | string | SHA-256 hash of the evidence bundle |
{
"type": "object",
"required": [
"bundleHash"
],
"properties": {
"bundleHash": {
"type": "string",
"description": "SHA-256 hash of the evidence bundle"
}
}
}Convert an existing bounty into an investment pool. Allows community staking toward the bounty's capability.
| Argument | Type | Description |
|---|---|---|
| bountyId* | string | Bounty ID to convert to a pool |
{
"type": "object",
"required": [
"bountyId"
],
"properties": {
"bountyId": {
"type": "string",
"description": "Bounty ID to convert to a pool"
}
}
}Register a capability instance for a kernel. Required before submitting jobs — the gateway needs at least one capability per kernel. Creates a liquid-handler, fdm, cnc-3axis, or other capability type.
| Argument | Type | Description |
|---|---|---|
| name | string | Human-readable name for the capability |
| type* | string | Capability type (e.g. liquid-handler, fdm, cnc-3axis, laser-cut, document-printing) |
| kernelId* | string | Kernel ID to register capability for |
| description | string | Description of what this capability does |
{
"type": "object",
"required": [
"kernelId",
"type"
],
"properties": {
"name": {
"type": "string",
"description": "Human-readable name for the capability"
},
"type": {
"type": "string",
"description": "Capability type (e.g. liquid-handler, fdm, cnc-3axis, laser-cut, document-printing)"
},
"kernelId": {
"type": "string",
"description": "Kernel ID to register capability for"
},
"description": {
"type": "string",
"description": "Description of what this capability does"
}
}
}Create an investment pool for a capability bounty. Stakers earn future protocol fees when the capability goes live.
| Argument | Type | Description |
|---|---|---|
| currency | string | Currency for the pool |
| description* | string | Description of the capability pool |
| targetAmount | number | Funding target amount |
| capabilityType* | string | Type of capability to invest in (e.g. cnc-milling, sla-printing) |
{
"type": "object",
"required": [
"capabilityType",
"description"
],
"properties": {
"currency": {
"enum": [
"USDC",
"CREDITS"
],
"type": "string",
"description": "Currency for the pool"
},
"description": {
"type": "string",
"description": "Description of the capability pool"
},
"targetAmount": {
"type": "number",
"description": "Funding target amount"
},
"capabilityType": {
"type": "string",
"description": "Type of capability to invest in (e.g. cnc-milling, sla-printing)"
}
}
}Register a new Shop Kernel (physical site) on the PCC network. Part of Step 2 in the onboarding flow.
| Argument | Type | Description |
|---|---|---|
| name* | string | Kernel/site name (e.g. 'BioPunk Lab - Bay A') |
| config | object | Kernel configuration JSON |
| location | object | Location object with address and geo coordinates |
| description | string | Description of the site and its capabilities |
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Kernel/site name (e.g. 'BioPunk Lab - Bay A')"
},
"config": {
"type": "object",
"description": "Kernel configuration JSON"
},
"location": {
"type": "object",
"description": "Location object with address and geo coordinates"
},
"description": {
"type": "string",
"description": "Description of the site and its capabilities"
}
}
}Create a new protocol template draft. Returns the new template ID.
| Argument | Type | Description |
|---|---|---|
| name* | string | Protocol name |
| tags | array | Tags for discovery |
| steps | array | Array of protocol step objects |
| transfers | array | Array of transfer objects between steps |
| parameters | array | Array of parameter definitions |
| description | string | Protocol description |
| requiredCapabilities | array | Required capability types |
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Protocol name"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags for discovery"
},
"steps": {
"type": "array",
"description": "Array of protocol step objects"
},
"transfers": {
"type": "array",
"description": "Array of transfer objects between steps"
},
"parameters": {
"type": "array",
"description": "Array of parameter definitions"
},
"description": {
"type": "string",
"description": "Protocol description"
},
"requiredCapabilities": {
"type": "array",
"items": {
"type": "string"
},
"description": "Required capability types"
}
}
}Instantiate a protocol template as a run on a specific kernel with given parameter values.
| Argument | Type | Description |
|---|---|---|
| id* | string | Protocol template ID |
| kernelId | string | Kernel ID to run the protocol on |
| sampleIds | array | Sample IDs being processed in this run |
| parameterValues | object | Runtime parameter values (overrides template defaults) |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Protocol template ID"
},
"kernelId": {
"type": "string",
"description": "Kernel ID to run the protocol on"
},
"sampleIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Sample IDs being processed in this run"
},
"parameterValues": {
"type": "object",
"description": "Runtime parameter values (overrides template defaults)"
}
}
}Create a new equipment shipment with origin, destination, package details, and provider.
| Argument | Type | Description |
|---|---|---|
| origin | object | Origin location with label, address, geo coordinates |
| package | object | Package details (weightKg, dimensions, fragile, etc.) |
| providerId | string | Logistics provider ID |
| destination | object | Destination location with label, address, geo coordinates |
| equipmentDescription* | string | Description of equipment being shipped |
{
"type": "object",
"required": [
"equipmentDescription"
],
"properties": {
"origin": {
"type": "object",
"description": "Origin location with label, address, geo coordinates"
},
"package": {
"type": "object",
"description": "Package details (weightKg, dimensions, fragile, etc.)"
},
"providerId": {
"type": "string",
"description": "Logistics provider ID"
},
"destination": {
"type": "object",
"description": "Destination location with label, address, geo coordinates"
},
"equipmentDescription": {
"type": "string",
"description": "Description of equipment being shipped"
}
}
}Remove a channel from an operator. Future jobs will not dispatch to it. Use update_operator_channel with enabled=false to silence temporarily without losing the recipe in `describe`.
| Argument | Type | Description |
|---|---|---|
| id* | string | Channel id. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Channel id."
}
}
}Deposit an operator bond for a milestone on-chain. Required for Assurance Tier 3 jobs. Returns transaction hash.
| Argument | Type | Description |
|---|---|---|
| address* | string | Escrow contract address (0x...) |
| milestoneIndex* | number | Milestone index to post bond for (0-based) |
{
"type": "object",
"required": [
"address",
"milestoneIndex"
],
"properties": {
"address": {
"type": "string",
"description": "Escrow contract address (0x...)"
},
"milestoneIndex": {
"type": "number",
"description": "Milestone index to post bond for (0-based)"
}
}
}File a dispute against the consensus verdict. Only verifiers who submitted a response can dispute. Requires additional evidence CID.
| Argument | Type | Description |
|---|---|---|
| reason* | string | Reason for disputing the consensus |
| requestId* | string | Verification request ID (hvreq_...) |
| disputerId* | string | Verifier node ID filing the dispute |
| evidenceCid* | string | IPFS CID of the counter-evidence |
{
"type": "object",
"required": [
"requestId",
"disputerId",
"reason",
"evidenceCid"
],
"properties": {
"reason": {
"type": "string",
"description": "Reason for disputing the consensus"
},
"requestId": {
"type": "string",
"description": "Verification request ID (hvreq_...)"
},
"disputerId": {
"type": "string",
"description": "Verifier node ID filing the dispute"
},
"evidenceCid": {
"type": "string",
"description": "IPFS CID of the counter-evidence"
}
}
}Set revenue splits for an IP asset among stakeholders (designer, operator, verifier, assembler, curator). Splits must sum to 100.
| Argument | Type | Description |
|---|---|---|
| ipId* | string | IP asset ID |
| splits* | array | Revenue splits — must sum to 100 |
{
"type": "object",
"required": [
"ipId",
"splits"
],
"properties": {
"ipId": {
"type": "string",
"description": "IP asset ID"
},
"splits": {
"type": "array",
"items": {
"type": "object",
"required": [
"address",
"role",
"percentage",
"label"
],
"properties": {
"role": {
"enum": [
"designer",
"operator",
"verifier",
"assembler",
"curator"
],
"type": "string"
},
"label": {
"type": "string",
"description": "Human-readable label"
},
"address": {
"type": "string",
"description": "Recipient EVM address"
},
"percentage": {
"type": "number",
"description": "Percentage share (0-100)"
}
}
},
"description": "Revenue splits — must sum to 100"
}
}
}Manually emit a telemetry event for a job pipeline phase. Used by kernels and agents to report execution progress.
| Argument | Type | Description |
|---|---|---|
| jobId* | string | Job ID |
| level | string | Log level for this event |
| phase* | string | Pipeline phase name (e.g. intake, binding, execution, evidence, settlement) |
| source | string | Source module or component |
| status* | string | Phase status |
| metadata | object | Additional event metadata |
| duration_ms | number | Phase duration in milliseconds |
{
"type": "object",
"required": [
"jobId",
"phase",
"status"
],
"properties": {
"jobId": {
"type": "string",
"description": "Job ID"
},
"level": {
"enum": [
"info",
"warn",
"error",
"debug"
],
"type": "string",
"description": "Log level for this event"
},
"phase": {
"type": "string",
"description": "Pipeline phase name (e.g. intake, binding, execution, evidence, settlement)"
},
"source": {
"type": "string",
"description": "Source module or component"
},
"status": {
"enum": [
"started",
"completed",
"failed",
"skipped"
],
"type": "string",
"description": "Phase status"
},
"metadata": {
"type": "object",
"description": "Additional event metadata"
},
"duration_ms": {
"type": "number",
"description": "Phase duration in milliseconds"
}
}
}Commit a proposed composition: drives the DAG through the workflow engine, each step records a reputation outcome, the composition's reputation is finalized when the run ends. When `PCC_COMPOSE_EXECUTE_REAL=true` is set on the gateway, steps submit real jobs via JobFacade and the workflow run is durable (@pcc/workflow). When the flag is off, the NOOP runner returns synthetic success — useful in dev/test. Re-executing an already-run composition replays the stored result (idempotent — reputation deltas are applied exactly once).
| Argument | Type | Description |
|---|---|---|
| id* | string | Composition id from propose_composition. Must be in `proposed` status and not expired. |
| idempotencyKey | string | Optional caller-supplied key (≤120 chars) to dedupe execute calls. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Composition id from propose_composition. Must be in `proposed` status and not expired."
},
"idempotencyKey": {
"type": "string",
"description": "Optional caller-supplied key (≤120 chars) to dedupe execute calls."
}
}
}File a dispute against a milestone on-chain. Challenger must post a bond and provide evidence hash. Returns transaction hash.
| Argument | Type | Description |
|---|---|---|
| reason* | string | Human-readable dispute reason |
| address* | string | Escrow contract address (0x...) |
| challengerBond* | string | Bond amount in wei (as string) |
| milestoneIndex* | number | Milestone index to dispute (0-based) |
| challengerEvidenceHash* | string | Evidence hash as 0x-prefixed hex bytes32 |
{
"type": "object",
"required": [
"address",
"milestoneIndex",
"challengerBond",
"challengerEvidenceHash",
"reason"
],
"properties": {
"reason": {
"type": "string",
"description": "Human-readable dispute reason"
},
"address": {
"type": "string",
"description": "Escrow contract address (0x...)"
},
"challengerBond": {
"type": "string",
"description": "Bond amount in wei (as string)"
},
"milestoneIndex": {
"type": "number",
"description": "Milestone index to dispute (0-based)"
},
"challengerEvidenceHash": {
"type": "string",
"description": "Evidence hash as 0x-prefixed hex bytes32"
}
}
}Fork an existing dashboard into a new artifact you own, preserving lineage back to the original (the social remix verb). Use this to adapt a popular dashboard rather than build from scratch — e.g. fork a 'watch pizza' dashboard and raise the budget or add a receipt window via update_dashboard. Increments the source's fork counter. You can fork any public/unlisted artifact, or a private one you own.
| Argument | Type | Description |
|---|---|---|
| id* | string | The id (ua_...) of the artifact to fork. |
| name | string | Optional name for the fork (defaults to '<original> (fork)'). |
| visibility | string | Visibility of the fork (default 'unlisted'). |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The id (ua_...) of the artifact to fork."
},
"name": {
"type": "string",
"description": "Optional name for the fork (defaults to '<original> (fork)')."
},
"visibility": {
"enum": [
"private",
"unlisted",
"public"
],
"type": "string",
"description": "Visibility of the fork (default 'unlisted')."
}
}
}Fork a protocol template to create your own version with parameter overrides. Returns the new fork ID.
| Argument | Type | Description |
|---|---|---|
| id* | string | Protocol template ID to fork |
| name | string | Name for the forked protocol |
| parameterOverrides | object | Parameter values to override from the source template |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Protocol template ID to fork"
},
"name": {
"type": "string",
"description": "Name for the forked protocol"
},
"parameterOverrides": {
"type": "object",
"description": "Parameter values to override from the source template"
}
}
}Fund a protocol-created escrow on-chain. Approval is handled INTERNALLY by the gateway for protocol-created escrows (audit C-03 removed the public approve step) — do NOT call a separate approve first; fund directly. Returns transaction hash.
| Argument | Type | Description |
|---|---|---|
| address* | string | Escrow contract address (0x...) |
{
"type": "object",
"required": [
"address"
],
"properties": {
"address": {
"type": "string",
"description": "Escrow contract address (0x...)"
}
}
}List currently active jobs with their current pipeline phase and telemetry status.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}Get anomalies involving a specific agent, plus their trust impact score.
| Argument | Type | Description |
|---|---|---|
| agentId* | string | Agent or kernel ID |
{
"type": "object",
"required": [
"agentId"
],
"properties": {
"agentId": {
"type": "string",
"description": "Agent or kernel ID"
}
}
}Get aggregate anomaly statistics — total, unresolved, by severity, by category.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}Get automation status for a specific instrument-to-instrument transfer pair.
| Argument | Type | Description |
|---|---|---|
| toNodeId* | string | Destination instrument node ID |
| fromNodeId* | string | Source instrument node ID |
{
"type": "object",
"required": [
"fromNodeId",
"toNodeId"
],
"properties": {
"toNodeId": {
"type": "string",
"description": "Destination instrument node ID"
},
"fromNodeId": {
"type": "string",
"description": "Source instrument node ID"
}
}
}Get the bounty hunter leaderboard showing top operators by bounties claimed and verified.
| Argument | Type | Description |
|---|---|---|
| limit | number | Number of entries to return (default 10) |
{
"type": "object",
"required": [],
"properties": {
"limit": {
"type": "number",
"description": "Number of entries to return (default 10)"
}
}
}Get configuration options for a capability type (materials, dimensions, tolerances, assurance tiers). Use before calling calculate_price.
| Argument | Type | Description |
|---|---|---|
| type* | string | Capability type (e.g. fdm, cnc-3axis, hplc) |
| profileId | string | Optional capability profile ID |
| selections | object | Current selections to refine available options |
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"description": "Capability type (e.g. fdm, cnc-3axis, hplc)"
},
"profileId": {
"type": "string",
"description": "Optional capability profile ID"
},
"selections": {
"type": "object",
"description": "Current selections to refine available options"
}
}
}Get IPFS CIDs for a bundle — returns the primary CID, metadata CID, and Filecoin deal ID if available.
| Argument | Type | Description |
|---|---|---|
| bundleId* | string | Evidence bundle ID |
{
"type": "object",
"required": [
"bundleId"
],
"properties": {
"bundleId": {
"type": "string",
"description": "Evidence bundle ID"
}
}
}Get the Story Protocol IP registration for a capability by its capability ID.
| Argument | Type | Description |
|---|---|---|
| capabilityId* | string | Capability ID to look up IP registration for |
{
"type": "object",
"required": [
"capabilityId"
],
"properties": {
"capabilityId": {
"type": "string",
"description": "Capability ID to look up IP registration for"
}
}
}Retrieve a previously-proposed composition by id. Returns 404 if unknown, 410 if the 30-minute proposal window has expired. Use this to inspect a plan before executing, or to recover a plan id after a restart.
| Argument | Type | Description |
|---|---|---|
| id* | string | Composition id (returned from propose_composition). |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Composition id (returned from propose_composition)."
}
}
}Recall a saved dashboard by its id or slug. Returns the full artifact (manifest + metadata). Use this to reload a dashboard the user asks for again ('open my pizza dashboard') instead of regenerating it — a saved dashboard reloads with zero regeneration. Public for public/unlisted artifacts; owner-only for private ones. Increments the load counter (a popularity signal).
| Argument | Type | Description |
|---|---|---|
| idOrSlug* | string | The artifact id (ua_...) or its slug (e.g. 'watch-my-pizza-8k3f', the tail of the /a/<slug> URL). |
{
"type": "object",
"required": [
"idOrSlug"
],
"properties": {
"idOrSlug": {
"type": "string",
"description": "The artifact id (ua_...) or its slug (e.g. 'watch-my-pizza-8k3f', the tail of the /a/<slug> URL)."
}
}
}Get network-wide demand vs supply timeline data for capacity planning and market analysis.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}DePIN treasury, soulbound capability certificates, and current reward epoch stats.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}List equipment classes (FDM printers, CNC mills, etc.) with market snapshot data including utilization, demand, and pricing.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}Get escrow details. Pass a DB ID for database record (with milestones and disputes), or an EVM address (0x...) to read directly from the blockchain.
| Argument | Type | Description |
|---|---|---|
| escrowId* | string | DB escrow ID or on-chain contract address (0x...) |
{
"type": "object",
"required": [
"escrowId"
],
"properties": {
"escrowId": {
"type": "string",
"description": "DB escrow ID or on-chain contract address (0x...)"
}
}
}Read full on-chain escrow state with all milestone details from the blockchain. More detailed than get_escrow for on-chain contracts.
| Argument | Type | Description |
|---|---|---|
| address* | string | On-chain escrow contract address (0x...) |
{
"type": "object",
"required": [
"address"
],
"properties": {
"address": {
"type": "string",
"description": "On-chain escrow contract address (0x...)"
}
}
}Read dispute state for a specific milestone from the blockchain.
| Argument | Type | Description |
|---|---|---|
| address* | string | Escrow contract address (0x...) |
| milestoneIndex* | number | Milestone index (0-based) |
{
"type": "object",
"required": [
"address",
"milestoneIndex"
],
"properties": {
"address": {
"type": "string",
"description": "Escrow contract address (0x...)"
},
"milestoneIndex": {
"type": "number",
"description": "Milestone index (0-based)"
}
}
}Get on-chain event history for an escrow contract. Returns funding, release, dispute, and bond events.
| Argument | Type | Description |
|---|---|---|
| address* | string | On-chain escrow contract address (0x...) |
| fromBlock | string | Starting block number (optional) |
{
"type": "object",
"required": [
"address"
],
"properties": {
"address": {
"type": "string",
"description": "On-chain escrow contract address (0x...)"
},
"fromBlock": {
"type": "string",
"description": "Starting block number (optional)"
}
}
}Get an encrypted evidence bundle by its bundle ID. Returns the encrypted payload and key capsules.
| Argument | Type | Description |
|---|---|---|
| bundleId* | string | Evidence bundle ID |
{
"type": "object",
"required": [
"bundleId"
],
"properties": {
"bundleId": {
"type": "string",
"description": "Evidence bundle ID"
}
}
}List equipment installation orders with step progress and status.
| Argument | Type | Description |
|---|---|---|
| status | string | Filter by installation status (draft, scheduled, in_progress, completed) |
{
"type": "object",
"required": [],
"properties": {
"status": {
"type": "string",
"description": "Filter by installation status (draft, scheduled, in_progress, completed)"
}
}
}Get the full IP lineage chain for an asset — parent capabilities and all derivative job registrations.
| Argument | Type | Description |
|---|---|---|
| ipId* | string | IP asset ID |
{
"type": "object",
"required": [
"ipId"
],
"properties": {
"ipId": {
"type": "string",
"description": "IP asset ID"
}
}
}Get a revenue snapshot for an IP asset — total earned, pending claims, and recent payments.
| Argument | Type | Description |
|---|---|---|
| ipId* | string | IP asset ID |
{
"type": "object",
"required": [
"ipId"
],
"properties": {
"ipId": {
"type": "string",
"description": "IP asset ID"
}
}
}Get job details including progress, evidence bundles, and milestones.
| Argument | Type | Description |
|---|---|---|
| jobId* | string | Job ID |
{
"type": "object",
"required": [
"jobId"
],
"properties": {
"jobId": {
"type": "string",
"description": "Job ID"
}
}
}Get full event timeline for a specific job — all pipeline phase transitions with timings and metadata.
| Argument | Type | Description |
|---|---|---|
| jobId* | string | Job ID to get pipeline timeline for |
{
"type": "object",
"required": [
"jobId"
],
"properties": {
"jobId": {
"type": "string",
"description": "Job ID to get pipeline timeline for"
}
}
}Get kernel details including full capability objects, devices, and queue.
| Argument | Type | Description |
|---|---|---|
| kernelId* | string | Kernel ID |
{
"type": "object",
"required": [
"kernelId"
],
"properties": {
"kernelId": {
"type": "string",
"description": "Kernel ID"
}
}
}List all devices registered under a specific kernel, including adapter configs and device types.
| Argument | Type | Description |
|---|---|---|
| kernelId* | string | Kernel ID |
{
"type": "object",
"required": [
"kernelId"
],
"properties": {
"kernelId": {
"type": "string",
"description": "Kernel ID"
}
}
}List all jobs submitted to a specific kernel, including job status and progress.
| Argument | Type | Description |
|---|---|---|
| kernelId* | string | Kernel ID |
{
"type": "object",
"required": [
"kernelId"
],
"properties": {
"kernelId": {
"type": "string",
"description": "Kernel ID"
}
}
}Get sensor channels for a specific kernel. Returns live channel descriptors.
| Argument | Type | Description |
|---|---|---|
| kernelId* | string | Kernel ID to get sensors for |
{
"type": "object",
"required": [
"kernelId"
],
"properties": {
"kernelId": {
"type": "string",
"description": "Kernel ID to get sensors for"
}
}
}Get Lit Protocol access conditions for a Lit-encrypted evidence bundle. Returns the conditions that gate decryption.
| Argument | Type | Description |
|---|---|---|
| bundleId* | string | Evidence bundle ID (must be Lit-encrypted) |
{
"type": "object",
"required": [
"bundleId"
],
"properties": {
"bundleId": {
"type": "string",
"description": "Evidence bundle ID (must be Lit-encrypted)"
}
}
}Logistics hub overview: active shipments, pending installations, and upcoming bookings.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}Equipment marketplace overview with demand/supply metrics across all capability types.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}Answers 501 not_available: operator certifications are not recorded on this gateway (there is no certification store; certifications typed at registration are the operator's own claim and are not checked).
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}Not available: no route answers GET /api/operator on this gateway. The operator's real kernels, devices and in-flight jobs are at GET /api/agent/me.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}Answers 501 not_available: operator earnings history is not recorded on this gateway. Per-job payment state is at GET /api/jobs/:jobId/execution.
| Argument | Type | Description |
|---|---|---|
| period | string | Time period for earnings data |
{
"type": "object",
"required": [],
"properties": {
"period": {
"enum": [
"7d",
"30d",
"90d",
"1y"
],
"type": "string",
"description": "Time period for earnings data"
}
}
}Answers 501 not_available: operator machines with utilization and uptime are not recorded on this gateway. The operator's real kernels, devices and in-flight jobs are at GET /api/agent/me.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}Four-slot substrate view for an operator: kernels, capabilities (with sla + availability), notification channels, and the per-kernel A2A agent-card URLs. Returns totals and a `missing` list naming any of the four onboarding slots that are still empty. Use this from an onboarding agent's wrap-up step to confirm 'are all four slots wired before I go live?' status is `ready` | `partial` | `unconfigured`. Public — operator slug is non-secret and the response carries no credentials (channel `credentialRef` values are vault references, not secrets).
| Argument | Type | Description |
|---|---|---|
| slug* | string | Operator slug — typically the operator's wallet address used as `operatorAddress` on their kernels. |
{
"type": "object",
"required": [
"slug"
],
"properties": {
"slug": {
"type": "string",
"description": "Operator slug — typically the operator's wallet address used as `operatorAddress` on their kernels."
}
}
}Get details of a specific investment pool including stakes, status, and revenue share terms.
| Argument | Type | Description |
|---|---|---|
| poolId* | string | Investment pool ID |
{
"type": "object",
"required": [
"poolId"
],
"properties": {
"poolId": {
"type": "string",
"description": "Investment pool ID"
}
}
}Check earnings from capability investment pools for a staker address.
| Argument | Type | Description |
|---|---|---|
| staker* | string | Address or DID of the staker |
{
"type": "object",
"required": [
"staker"
],
"properties": {
"staker": {
"type": "string",
"description": "Address or DID of the staker"
}
}
}Return CSDs sorted by adoption (usage-count descending). Useful for first-time operators who want to see what kind of capabilities others are publishing. Each entry includes the CSD record plus usage attribution: count, recent adopters (deduped, capped at 50), and lastUsedAt.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Max results (1..50, default 10). |
{
"type": "object",
"required": [],
"properties": {
"limit": {
"type": "integer",
"maximum": 50,
"minimum": 1,
"description": "Max results (1..50, default 10)."
}
}
}Get protocol template details by ID. Returns steps, transfers, parameters, and metadata.
| Argument | Type | Description |
|---|---|---|
| id* | string | Protocol template ID |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Protocol template ID"
}
}
}List all forks of a protocol template. Shows who forked it and what parameters they changed.
| Argument | Type | Description |
|---|---|---|
| id* | string | Protocol template ID |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Protocol template ID"
}
}
}Get protocol run status including step progress, transfer status, current phase, and evidence hashes.
| Argument | Type | Description |
|---|---|---|
| runId* | string | Protocol run ID |
{
"type": "object",
"required": [
"runId"
],
"properties": {
"runId": {
"type": "string",
"description": "Protocol run ID"
}
}
}Get details of a specific machine registration by ID, including capabilities, pricing, operator info, and current status.
| Argument | Type | Description |
|---|---|---|
| registrationId* | string | Registration ID |
{
"type": "object",
"required": [
"registrationId"
],
"properties": {
"registrationId": {
"type": "string",
"description": "Registration ID"
}
}
}List all registered sensor channels across kernels. Returns channel descriptors with units and ranges.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}Get settlement epoch history showing past batch settlements with timing and operation counts.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}Get settlement pipeline status including pending operations count, total value queued, and smart account address.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}Get shipping quotes from logistics providers based on origin, destination, weight, and priority.
| Argument | Type | Description |
|---|---|---|
| priority | string | Shipping priority level |
| weightKg | number | Package weight in kg |
| originZip | string | Origin ZIP code |
| destinationZip | string | Destination ZIP code |
{
"type": "object",
"required": [],
"properties": {
"priority": {
"enum": [
"standard",
"expedited",
"rush"
],
"type": "string",
"description": "Shipping priority level"
},
"weightKg": {
"type": "number",
"description": "Package weight in kg"
},
"originZip": {
"type": "string",
"description": "Origin ZIP code"
},
"destinationZip": {
"type": "string",
"description": "Destination ZIP code"
}
}
}List equipment shipments with tracking status. Optionally filter by status.
| Argument | Type | Description |
|---|---|---|
| status | string | Filter by shipment status (in_transit, delivered, pickup_scheduled, etc.) |
{
"type": "object",
"required": [],
"properties": {
"status": {
"type": "string",
"description": "Filter by shipment status (in_transit, delivered, pickup_scheduled, etc.)"
}
}
}Get detailed information about a hosting space including power, amenities, safety features, and pricing.
| Argument | Type | Description |
|---|---|---|
| id* | string | Space ID |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Space ID"
}
}
}List space bookings for hosting equipment. Optionally filter by status or space.
| Argument | Type | Description |
|---|---|---|
| status | string | Filter by booking status |
| spaceId | string | Filter by space ID |
{
"type": "object",
"required": [],
"properties": {
"status": {
"type": "string",
"description": "Filter by booking status"
},
"spaceId": {
"type": "string",
"description": "Filter by space ID"
}
}
}List verification subnet miners on the Bittensor network. Returns miner addresses, scores, and leaderboard positions.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}Get Bittensor verification subnet health, agent bridge status, and network connectivity.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}Query structured logs with filters for level, source, jobId, kernelId, time range, and full-text search.
| Argument | Type | Description |
|---|---|---|
| after | string | Return logs after this ISO timestamp |
| jobId | string | Filter by job ID |
| level | string | Filter by log level |
| limit | number | Max entries to return (default 200) |
| before | string | Return logs before this ISO timestamp |
| search | string | Full-text search query |
| source | string | Filter by source module |
| kernelId | string | Filter by kernel ID |
{
"type": "object",
"required": [],
"properties": {
"after": {
"type": "string",
"description": "Return logs after this ISO timestamp"
},
"jobId": {
"type": "string",
"description": "Filter by job ID"
},
"level": {
"enum": [
"debug",
"info",
"warn",
"error"
],
"type": "string",
"description": "Filter by log level"
},
"limit": {
"type": "number",
"description": "Max entries to return (default 200)"
},
"before": {
"type": "string",
"description": "Return logs before this ISO timestamp"
},
"search": {
"type": "string",
"description": "Full-text search query"
},
"source": {
"type": "string",
"description": "Filter by source module"
},
"kernelId": {
"type": "string",
"description": "Filter by kernel ID"
}
}
}Get aggregate pipeline telemetry statistics including phase timings, success rates, and throughput metrics across all jobs.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}Read the ERC-20 token allowance granted by an owner to a spender from the blockchain.
| Argument | Type | Description |
|---|---|---|
| owner* | string | Token owner address (0x...) |
| spender* | string | Spender address (0x...) |
| tokenAddress* | string | ERC-20 token contract address (0x...) |
{
"type": "object",
"required": [
"tokenAddress",
"owner",
"spender"
],
"properties": {
"owner": {
"type": "string",
"description": "Token owner address (0x...)"
},
"spender": {
"type": "string",
"description": "Spender address (0x...)"
},
"tokenAddress": {
"type": "string",
"description": "ERC-20 token contract address (0x...)"
}
}
}Read an ERC-20 token balance for an account address from the blockchain.
| Argument | Type | Description |
|---|---|---|
| account* | string | Account address to check balance for (0x...) |
| tokenAddress* | string | ERC-20 token contract address (0x...) |
{
"type": "object",
"required": [
"tokenAddress",
"account"
],
"properties": {
"account": {
"type": "string",
"description": "Account address to check balance for (0x...)"
},
"tokenAddress": {
"type": "string",
"description": "ERC-20 token contract address (0x...)"
}
}
}Get top demand signals aggregated by capability type. Shows which capabilities are most wanted on the network.
| Argument | Type | Description |
|---|---|---|
| limit | number | Number of top demand entries to return (default 10) |
{
"type": "object",
"required": [],
"properties": {
"limit": {
"type": "number",
"description": "Number of top demand entries to return (default 10)"
}
}
}Get resource transfer graphs showing instrument topology, transfer edges, and mechanisms for all kernels.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}List all unresolved anomalies on the network. Filter by severity, category, or target agent.
| Argument | Type | Description |
|---|---|---|
| category | string | Filter by category |
| severity | string | Filter by severity: info, warning, critical |
| targetId | string | Filter by target agent/kernel ID |
{
"type": "object",
"required": [],
"properties": {
"category": {
"type": "string",
"description": "Filter by category"
},
"severity": {
"type": "string",
"description": "Filter by severity: info, warning, critical"
},
"targetId": {
"type": "string",
"description": "Filter by target agent/kernel ID"
}
}
}Get pending verification assignments for a verifier node. Returns requests this verifier has been assigned but not yet responded to.
| Argument | Type | Description |
|---|---|---|
| verifierId* | string | Verifier node ID |
{
"type": "object",
"required": [
"verifierId"
],
"properties": {
"verifierId": {
"type": "string",
"description": "Verifier node ID"
}
}
}Get verification status for a request. Returns vote tally, consensus state, dispute list, and pending response count.
| Argument | Type | Description |
|---|---|---|
| requestId* | string | Verification request ID (hvreq_...) |
{
"type": "object",
"required": [
"requestId"
],
"properties": {
"requestId": {
"type": "string",
"description": "Verification request ID (hvreq_...)"
}
}
}Get detailed workflow information including steps, node assignments, and progress.
| Argument | Type | Description |
|---|---|---|
| workflowId* | string | Workflow ID |
{
"type": "object",
"required": [
"workflowId"
],
"properties": {
"workflowId": {
"type": "string",
"description": "Workflow ID"
}
}
}List active instrument workflows in the orchestrator. Optionally filter by status.
| Argument | Type | Description |
|---|---|---|
| status | string | Filter by workflow status (e.g. running, completed) |
{
"type": "object",
"required": [],
"properties": {
"status": {
"type": "string",
"description": "Filter by workflow status (e.g. running, completed)"
}
}
}Check if on-chain write operations are enabled (requires PCC_GATEWAY_PRIVATE_KEY to be configured). Returns write status and signer address.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}Grant a new recipient access to an encrypted evidence bundle. Creates a re-encrypted key capsule for the recipient.
| Argument | Type | Description |
|---|---|---|
| bundleId* | string | Evidence bundle ID |
| accessLevel | string | Level of access to grant (default: full) |
| recipientAddress* | string | Recipient EVM address (0x...) |
{
"type": "object",
"required": [
"bundleId",
"recipientAddress"
],
"properties": {
"bundleId": {
"type": "string",
"description": "Evidence bundle ID"
},
"accessLevel": {
"enum": [
"full",
"selective",
"summary_only"
],
"type": "string",
"description": "Level of access to grant (default: full)"
},
"recipientAddress": {
"type": "string",
"description": "Recipient EVM address (0x...)"
}
}
}Announce capabilities for a kernel. NOTE: the gateway currently acknowledges this call but stores nothing, so it does not put any capability on the network. To publish a capability, use create_capability (POST /api/capabilities).
| Argument | Type | Description |
|---|---|---|
| devices | array | Device IDs that back these capabilities |
| kernelId* | string | Kernel ID |
| signature | string | Ed25519 signature of the announcement |
| capabilities* | array | Capability objects to announce |
{
"type": "object",
"required": [
"kernelId",
"capabilities"
],
"properties": {
"devices": {
"type": "array",
"items": {
"type": "string"
},
"description": "Device IDs that back these capabilities"
},
"kernelId": {
"type": "string",
"description": "Kernel ID"
},
"signature": {
"type": "string",
"description": "Ed25519 signature of the announcement"
},
"capabilities": {
"type": "array",
"items": {
"type": "object"
},
"description": "Capability objects to announce"
}
}
}Send a per-kernel heartbeat to keep the kernel marked online. Used by pcc-node daemons as an alternative to the operator relay heartbeat.
| Argument | Type | Description |
|---|---|---|
| status | string | Kernel status (online/offline) |
| kernelId* | string | Kernel ID |
| capabilities | array | Optional capability announcements |
{
"type": "object",
"required": [
"kernelId"
],
"properties": {
"status": {
"type": "string",
"default": "online",
"description": "Kernel status (online/offline)"
},
"kernelId": {
"type": "string",
"description": "Kernel ID"
},
"capabilities": {
"type": "array",
"items": {
"type": "object"
},
"description": "Optional capability announcements"
}
}
}List all active API keys for the authenticated operator. Returns key IDs, prefixes, scopes, rate limits, usage counts, and creation/expiry timestamps. Requires a valid API key or SIWE session.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}List automation status for all instrument transfer pairs. Shows current automation level, episode count, and training readiness. Filter by kernelId.
| Argument | Type | Description |
|---|---|---|
| kernelId | string | Filter by kernel ID |
{
"type": "object",
"required": [],
"properties": {
"kernelId": {
"type": "string",
"description": "Filter by kernel ID"
}
}
}List active and completed settlement batches.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}List open bounties for capabilities the network needs. Operators can claim these to earn rewards by onboarding new capabilities.
| Argument | Type | Description |
|---|---|---|
| status | string | Filter by bounty status |
| capabilityType | string | Filter by capability type |
{
"type": "object",
"required": [],
"properties": {
"status": {
"enum": [
"open",
"claimed",
"verified",
"paid",
"expired"
],
"type": "string",
"description": "Filter by bounty status"
},
"capabilityType": {
"type": "string",
"description": "Filter by capability type"
}
}
}List all capability types registered on the network (FDM, SLA, CNC, HPLC, etc.) with metadata.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}List agent-to-agent conversations showing topic, participants, message count, and status.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}List escrow contracts with milestones and bonds. Optionally filter by status.
| Argument | Type | Description |
|---|---|---|
| status | string | Filter by escrow status |
{
"type": "object",
"required": [],
"properties": {
"status": {
"type": "string",
"description": "Filter by escrow status"
}
}
}List encrypted evidence bundles stored in the gateway.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}List all evidence access grants for an address. Returns bundles the address has been granted access to.
| Argument | Type | Description |
|---|---|---|
| address* | string | EVM address to look up grants for (0x...) |
{
"type": "object",
"required": [
"address"
],
"properties": {
"address": {
"type": "string",
"description": "EVM address to look up grants for (0x...)"
}
}
}List all jobs with status. Optionally filter by kernelId or status.
| Argument | Type | Description |
|---|---|---|
| status | string | Filter by status (pending, queued, in_progress, paused, completed, failed, cancelled) |
| kernelId | string | Filter by kernel ID |
{
"type": "object",
"required": [],
"properties": {
"status": {
"type": "string",
"description": "Filter by status (pending, queued, in_progress, paused, completed, failed, cancelled)"
},
"kernelId": {
"type": "string",
"description": "Filter by kernel ID"
}
}
}List all Shop Kernels on the network with status and capability types. Optionally filter by status.
| Argument | Type | Description |
|---|---|---|
| status | string | Filter by kernel status (online, offline, maintenance) |
{
"type": "object",
"required": [],
"properties": {
"status": {
"type": "string",
"description": "Filter by kernel status (online, offline, maintenance)"
}
}
}List every channel attached to an operator. Returns the full channel records (id, transport, direction, endpoint, describe, enabled flags). Useful for an operator's onboarding agent to confirm what is wired up, and for status dashboards.
| Argument | Type | Description |
|---|---|---|
| slug* | string | Operator slug. |
{
"type": "object",
"required": [
"slug"
],
"properties": {
"slug": {
"type": "string",
"description": "Operator slug."
}
}
}List all investment pools. Optionally filter by status or capability type.
| Argument | Type | Description |
|---|---|---|
| status | string | Filter by pool status |
| capabilityType | string | Filter by capability type |
{
"type": "object",
"required": [],
"properties": {
"status": {
"enum": [
"open",
"funded",
"active",
"sunset",
"cancelled"
],
"type": "string",
"description": "Filter by pool status"
},
"capabilityType": {
"type": "string",
"description": "Filter by capability type"
}
}
}List protocol runs. Filter by status or kernelId.
| Argument | Type | Description |
|---|---|---|
| status | string | Filter by run status |
| kernelId | string | Filter by kernel ID |
{
"type": "object",
"required": [],
"properties": {
"status": {
"enum": [
"binding",
"ready",
"running",
"paused",
"completed",
"cancelled",
"failed"
],
"type": "string",
"description": "Filter by run status"
},
"kernelId": {
"type": "string",
"description": "Filter by kernel ID"
}
}
}List protocol templates in the library. Filter by tags, required capabilities, search query, or status.
| Argument | Type | Description |
|---|---|---|
| tags | string | Comma-separated tag filter (e.g. 'biotech,protein') |
| search | string | Full-text search query |
| status | string | Filter by template status |
| capabilities | string | Comma-separated required capability filter (e.g. 'hplc,centrifuge') |
{
"type": "object",
"required": [],
"properties": {
"tags": {
"type": "string",
"description": "Comma-separated tag filter (e.g. 'biotech,protein')"
},
"search": {
"type": "string",
"description": "Full-text search query"
},
"status": {
"enum": [
"draft",
"published",
"archived"
],
"type": "string",
"description": "Filter by template status"
},
"capabilities": {
"type": "string",
"description": "Comma-separated required capability filter (e.g. 'hplc,centrifuge')"
}
}
}List all machine registrations on the network. See pending, approved, active, and rejected registrations. Public endpoint — no auth required.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}List all transfer agents (robots and human operators) available for instrument-to-instrument transfers.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}Decrypt a Lit Protocol-encrypted evidence bundle using a Lit auth signature. Returns the decrypted bundle payload.
| Argument | Type | Description |
|---|---|---|
| authSig* | object | Lit auth signature object with sig, derivedVia, signedMessage, and address fields |
| bundleId* | string | Evidence bundle ID (must be Lit-encrypted) |
{
"type": "object",
"required": [
"bundleId",
"authSig"
],
"properties": {
"authSig": {
"type": "object",
"properties": {
"sig": {
"type": "string"
},
"address": {
"type": "string"
},
"derivedVia": {
"type": "string"
},
"signedMessage": {
"type": "string"
}
},
"description": "Lit auth signature object with sig, derivedVia, signedMessage, and address fields"
},
"bundleId": {
"type": "string",
"description": "Evidence bundle ID (must be Lit-encrypted)"
}
}
}List all supplies and materials marketplace categories with the count of active listings in each. Categories cover the full spectrum of physical production inputs: raw metals, plastics, lab reagents, consumables, electronics, tooling, and more.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}Create a new supplies/materials listing in the marketplace. Suppliers post available raw materials, lab reagents, tooling, or consumables for other operators to purchase.
| Argument | Type | Description |
|---|---|---|
| name* | string | Product name |
| tags | array | Search tags |
| unit* | string | Unit of sale: kg, L, each, box, plate, etc. |
| inStock | boolean | Whether the item is currently available |
| category* | string | Category: raw-metals, plastics-polymers, lab-reagents, lab-consumables, electronics, chemicals, biologicals, tooling, packaging, calibration, safety, other |
| location | string | Supplier region or country |
| maxOrder | number | Maximum order quantity |
| minOrder | number | Minimum order quantity |
| sellerId | string | Supplier entity ID |
| description |
Remove a supplies/materials listing from the marketplace. The listing is immediately hidden from search results.
| Argument | Type | Description |
|---|---|---|
| id* | string | Listing ID to remove |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Listing ID to remove"
}
}
}Get full details of a specific supplies/materials marketplace listing by ID. Returns pricing, availability, lead time, location, and tags.
| Argument | Type | Description |
|---|---|---|
| id* | string | Listing ID (e.g. 'lst-al6061-bar') |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Listing ID (e.g. 'lst-al6061-bar')"
}
}
}Get details of a specific supply order including the associated listing details, quantity, total price, status, and optional escrow address.
| Argument | Type | Description |
|---|---|---|
| id* | string | Order ID (e.g. 'ord-demo-001') |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Order ID (e.g. 'ord-demo-001')"
}
}
}Search and filter supplies/materials marketplace listings. Operators buy raw materials here to fulfill capability contracts. Filter by category, in-stock status, location, or free-text query.
| Argument | Type | Description |
|---|---|---|
| query | string | Full-text search across name, description, and tags |
| inStock | string | Filter to only in-stock listings |
| category | string | Filter by category: raw-metals, plastics-polymers, lab-reagents, lab-consumables, electronics, chemicals, biologicals, tooling, packaging, calibration, safety, other |
| location | string | Filter by region (e.g. 'US-Midwest', 'EU-West', 'Asia-Pacific') |
{
"type": "object",
"required": [],
"properties": {
"query": {
"type": "string",
"description": "Full-text search across name, description, and tags"
},
"inStock": {
"enum": [
"true",
"false"
],
"type": "string",
"description": "Filter to only in-stock listings"
},
"category": {
"type": "string",
"description": "Filter by category: raw-metals, plastics-polymers, lab-reagents, lab-consumables, electronics, chemicals, biologicals, tooling, packaging, calibration, safety, other"
},
"location": {
"type": "string",
"description": "Filter by region (e.g. 'US-Midwest', 'EU-West', 'Asia-Pacific')"
}
}
}List marketplace supply orders. Filter by buyerId, sellerId, or status. Returns order history with pricing and status.
| Argument | Type | Description |
|---|---|---|
| status | string | Filter by order status |
| buyerId | string | Filter to orders placed by this buyer |
| sellerId | string | Filter to orders received by this seller |
{
"type": "object",
"required": [],
"properties": {
"status": {
"enum": [
"pending",
"confirmed",
"shipped",
"delivered",
"cancelled"
],
"type": "string",
"description": "Filter by order status"
},
"buyerId": {
"type": "string",
"description": "Filter to orders placed by this buyer"
},
"sellerId": {
"type": "string",
"description": "Filter to orders received by this seller"
}
}
}Place a purchase order for supplies or materials. Calculates total price automatically (quantity × pricePerUnit). Returns an order with 'pending' status. Optionally links to an on-chain escrow for trustless settlement.
| Argument | Type | Description |
|---|---|---|
| buyerId | string | Buyer entity ID (operator kernel ID, etc.) |
| quantity* | number | Quantity to order (must meet listing minOrder/maxOrder) |
| listingId* | string | Listing ID to order from |
| escrowAddress | string | Optional on-chain escrow address for trustless settlement |
{
"type": "object",
"required": [
"listingId",
"quantity"
],
"properties": {
"buyerId": {
"type": "string",
"description": "Buyer entity ID (operator kernel ID, etc.)"
},
"quantity": {
"type": "number",
"description": "Quantity to order (must meet listing minOrder/maxOrder)"
},
"listingId": {
"type": "string",
"description": "Listing ID to order from"
},
"escrowAddress": {
"type": "string",
"description": "Optional on-chain escrow address for trustless settlement"
}
}
}Update an existing supplies/materials listing (price, stock status, description, etc.). Pass only the fields you want to change.
| Argument | Type | Description |
|---|---|---|
| id* | string | Listing ID to update |
| tags | array | Updated search tags |
| inStock | boolean | Stock availability |
| description | string | Updated description |
| leadTimeDays | number | Updated lead time in days |
| pricePerUnit | number | New price per unit in USDC |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Listing ID to update"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Updated search tags"
},
"inStock": {
"type": "boolean",
"description": "Stock availability"
},
"description": {
"type": "string",
"description": "Updated description"
},
"leadTimeDays": {
"type": "number",
"description": "Updated lead time in days"
},
"pricePerUnit": {
"type": "number",
"description": "New price per unit in USDC"
}
}
}Find hosting spaces that match specific machine requirements (voltage, area, etc.). Returns scored matches.
| Argument | Type | Description |
|---|---|---|
| minArea | number | Minimum floor area in square feet |
| voltage | number | Required voltage (e.g. 208, 480) |
{
"type": "object",
"required": [],
"properties": {
"minArea": {
"type": "number",
"description": "Minimum floor area in square feet"
},
"voltage": {
"type": "number",
"description": "Required voltage (e.g. 208, 480)"
}
}
}Mint a soulbound capability certificate (cNFT via Metaplex Core) for a kernel. Proves a verified capability on-chain as an immutable credential. Step 5 of onboarding.
| Argument | Type | Description |
|---|---|---|
| metadata | object | Additional metadata (tolerances, materials, calibration proof CID) |
| kernelDid* | string | DID of the kernel (e.g. did:pcc:kernel:biolab-01) |
| assuranceTier | number | Assurance tier (0-3) |
| capabilityType* | string | Capability type (e.g. fdm, cnc-3axis, hplc) |
{
"type": "object",
"required": [
"kernelDid",
"capabilityType"
],
"properties": {
"metadata": {
"type": "object",
"description": "Additional metadata (tolerances, materials, calibration proof CID)"
},
"kernelDid": {
"type": "string",
"description": "DID of the kernel (e.g. did:pcc:kernel:biolab-01)"
},
"assuranceTier": {
"type": "number",
"description": "Assurance tier (0-3)"
},
"capabilityType": {
"type": "string",
"description": "Capability type (e.g. fdm, cnc-3axis, hplc)"
}
}
}Submit a cross-chain payment intent to the NEAR 1Click solver network. Creates a signed intent that routes the payment atomically across chains. Call near_quote first to obtain a quoteId. Intents typically settle within 30-60 seconds — poll near_intent_status to track progress.
| Argument | Type | Description |
|---|---|---|
| quoteId* | string | Quote ID returned from near_quote |
| recipient | string | Recipient address on the destination chain (optional) |
| workflowId* | string | PCC workflow or job ID this payment is for |
{
"type": "object",
"required": [
"quoteId",
"workflowId"
],
"properties": {
"quoteId": {
"type": "string",
"description": "Quote ID returned from near_quote"
},
"recipient": {
"type": "string",
"description": "Recipient address on the destination chain (optional)"
},
"workflowId": {
"type": "string",
"description": "PCC workflow or job ID this payment is for"
}
}
}Check the settlement status of a submitted NEAR 1Click cross-chain payment intent. Statuses progress: pending → submitted → settled | failed. Returns txHash and explorerUrl when settled.
| Argument | Type | Description |
|---|---|---|
| intentId* | string | Intent ID returned from near_intent |
{
"type": "object",
"required": [
"intentId"
],
"properties": {
"intentId": {
"type": "string",
"description": "Intent ID returned from near_intent"
}
}
}Get a cross-chain payment quote from the NEAR 1Click solver network (chaindefuser.com). Provides optimal routing and fee estimates for funding PCC escrow contracts using any source asset on any supported chain. Call near_status first to confirm available chains/assets.
| Argument | Type | Description |
|---|---|---|
| amount* | string | Amount as an integer string in the smallest denomination (e.g. '1000000' for 1 USDC with 6 decimals) |
| toAsset* | string | Destination asset symbol (e.g. 'USDC') |
| toChain* | string | Destination chain (e.g. 'base', 'eth') |
| fromAsset* | string | Source asset symbol (e.g. 'USDC', 'ETH', 'NEAR') |
| fromChain* | string | Source chain (e.g. 'eth', 'base', 'near', 'arbitrum') |
| recipient | string | Recipient address on the destination chain (optional) |
{
"type": "object",
"required": [
"fromChain",
"fromAsset",
"toChain",
"toAsset",
"amount"
],
"properties": {
"amount": {
"type": "string",
"description": "Amount as an integer string in the smallest denomination (e.g. '1000000' for 1 USDC with 6 decimals)"
},
"toAsset": {
"type": "string",
"description": "Destination asset symbol (e.g. 'USDC')"
},
"toChain": {
"type": "string",
"description": "Destination chain (e.g. 'base', 'eth')"
},
"fromAsset": {
"type": "string",
"description": "Source asset symbol (e.g. 'USDC', 'ETH', 'NEAR')"
},
"fromChain": {
"type": "string",
"description": "Source chain (e.g. 'eth', 'base', 'near', 'arbitrum')"
},
"recipient": {
"type": "string",
"description": "Recipient address on the destination chain (optional)"
}
}
}Get NEAR Protocol chain-abstraction integration status. Returns supported chains (near, eth, base, arbitrum, optimism, polygon), supported assets (USDC, USDT, NEAR, ETH, WBTC), and capability flags. Use this to confirm cross-chain settlement is available before requesting quotes.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}Register a new machine on the PCC network. Provide machine details to create a registration record. Include `operator` ({walletAddress, displayName, email}): without it the registration is recorded as operator 0x0000000000000000000000000000000000000000 / "Unknown", and prove cannot match it to you.
| Argument | Type | Description |
|---|---|---|
| name* | string | Machine name |
| model | string | Model identifier |
| category* | string | Machine category (e.g. fdm, cnc, laser-cut, hplc) |
| operator | object | Who owns this machine. prove and activate match the caller against operator.walletAddress (or operator.email). |
| description | string | Machine description |
| capabilities | array | Array of capability objects |
| manufacturer | string | Manufacturer name |
{
"type": "object",
"required": [
"name",
"category"
],
"properties": {
"name": {
"type": "string",
"description": "Machine name"
},
"model": {
"type": "string",
"description": "Model identifier"
},
"category": {
"type": "string",
"description": "Machine category (e.g. fdm, cnc, laser-cut, hplc)"
},
"operator": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"displayName": {
"type": "string"
},
"walletAddress": {
"type": "string",
"description": "0x… address"
}
},
"description": "Who owns this machine. prove and activate match the caller against operator.walletAddress (or operator.email)."
},
"description": {
"type": "string",
"description": "Machine description"
},
"capabilities": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of capability objects"
},
"manufacturer": {
"type": "string",
"description": "Manufacturer name"
}
}
}Operator sends heartbeat with capability re-announcement. Keeps the kernel alive on the network and updates its own capability rows. Requires operate authority for this kernel: its recorded operator identity (the caller that registered it), its proven operator wallet, or the gateway admin authority. Another identity gets 403; no credentials gets 401; an unregistered kernel gets 404 for a non-admin. Operator identity proof for operate is completed by WP-A (DECISIONS items 136 and 138).
| Argument | Type | Description |
|---|---|---|
| kernelId* | string | |
| capabilities | array |
{
"type": "object",
"required": [
"kernelId"
],
"properties": {
"kernelId": {
"type": "string"
},
"capabilities": {
"type": "array",
"items": {
"type": "object"
}
}
}
}Operator polls jobs assigned to their kernel; status defaults to queued, and the route can filter any status. Requires operate authority for this kernel: its recorded operator identity (the caller that registered it), its proven operator wallet, or the gateway admin authority. Another identity gets 403; no credentials gets 401; an unregistered kernel gets 404 for a non-admin. Operator identity proof for operate is completed by WP-A (DECISIONS items 136 and 138). The pcc-node 0.1.1 daemon does not call it: it takes no jobs.
| Argument | Type | Description |
|---|---|---|
| kernelId* | string | Kernel ID to poll jobs for |
{
"type": "object",
"required": [
"kernelId"
],
"properties": {
"kernelId": {
"type": "string",
"description": "Kernel ID to poll jobs for"
}
}
}Operator pushes evidence bundle from a completed job execution. Requires decide authority for the stored job's kernel: its proven operator wallet or the gateway admin authority. A matching claimed operator key gets 403 operator_proof_required. Evidence takes decide, per DECISIONS 2026-10-04 01:25 (N31c). Evidence is posted with the kernel's proven operator wallet authority (decide). The body's kernelId cannot choose the authorization target. No credentials gets 401 before the job read; a job without a kernel gets 403 for a non-admin. Contains device ID, execution timestamp, result payload, and event timeline. Success is a receipt with stored: true naming this jobId. HTTP 200 with stored: false means nothing was stored: never follow it with status completed.
| Argument | Type | Description |
|---|---|---|
| jobId* | string | |
| evidence* | object | |
| kernelId* | string |
{
"type": "object",
"required": [
"jobId",
"kernelId",
"evidence"
],
"properties": {
"jobId": {
"type": "string"
},
"evidence": {
"type": "object"
},
"kernelId": {
"type": "string"
}
}
}Operator reports a job's status (in_progress, completed, failed). Requires operate authority for the stored job's kernel: its recorded operator identity (the caller that registered it), its proven operator wallet, or the gateway admin authority. The body's kernelId cannot choose the authorization target. Another identity gets 403; no credentials gets 401 before the job read; a job without a kernel gets 403 for a non-admin. Operator identity proof for operate is completed by WP-A (DECISIONS items 136 and 138). The node path finishes a job in two calls: submit its evidence (POST /api/operator/evidence, posted with the kernel's proven operator wallet authority, decide), and only if that receipt says stored: true for this jobId, set status completed here. HTTP 200 alone is not enough: the relay answers 200 with stored: false when it could not store the evidence (an unknown job, a storage failure); then set failed with the reason evidence_not_stored. On the current gateway, completed marks the job done and its timeline then says settled, but the escrow is not released yet (board G1). Do not call pcc_job_complete after this: it answers 409.
| Argument | Type | Description |
|---|---|---|
| jobId* | string | |
| status* | string | |
| kernelId* | string | |
| metadata | object |
{
"type": "object",
"required": [
"jobId",
"kernelId",
"status"
],
"properties": {
"jobId": {
"type": "string"
},
"status": {
"enum": [
"in_progress",
"completed",
"failed"
],
"type": "string"
},
"kernelId": {
"type": "string"
},
"metadata": {
"type": "object"
}
}
}Pause a running protocol run. Use resume_protocol_run to continue.
| Argument | Type | Description |
|---|---|---|
| runId* | string | Protocol run ID to pause |
{
"type": "object",
"required": [
"runId"
],
"properties": {
"runId": {
"type": "string",
"description": "Protocol run ID to pause"
}
}
}Pay royalties to an IP asset vault. The payer sends tokens that flow to stakeholders via the royalty splits.
| Argument | Type | Description |
|---|---|---|
| ipId* | string | IP asset ID |
| amount* | string | Amount to pay in wei (as string) |
| payerAddress* | string | EVM address of the payer |
{
"type": "object",
"required": [
"ipId",
"amount",
"payerAddress"
],
"properties": {
"ipId": {
"type": "string",
"description": "IP asset ID"
},
"amount": {
"type": "string",
"description": "Amount to pay in wei (as string)"
},
"payerAddress": {
"type": "string",
"description": "EVM address of the payer"
}
}
}Price a configured PCC capability (typed operation). Returns the itemized quote for the given capability type + selections. Pure calculation — no funds move and nothing is created. Maps to POST /api/build/price.
| Argument | Type | Description |
|---|---|---|
| type* | string | Capability type, e.g. 'fdm'. |
| profileId | string | |
| selections* | object | Parameter selections. |
| capabilityId | string |
{
"type": "object",
"required": [
"type",
"selections"
],
"properties": {
"type": {
"type": "string",
"description": "Capability type, e.g. 'fdm'."
},
"profileId": {
"type": "string"
},
"selections": {
"type": "object",
"description": "Parameter selections."
},
"capabilityId": {
"type": "string"
}
},
"additionalProperties": false
}Assign an operator to a specific capability node within a request. The node status changes to 'assigned'. Operators claim nodes to indicate they will execute that capability.
| Argument | Type | Description |
|---|---|---|
| nodeId* | string | Capability node ID |
| requestId* | string | Request ID |
| operatorId* | string | Operator kernel ID or wallet address |
{
"type": "object",
"required": [
"requestId",
"nodeId",
"operatorId"
],
"properties": {
"nodeId": {
"type": "string",
"description": "Capability node ID"
},
"requestId": {
"type": "string",
"description": "Request ID"
},
"operatorId": {
"type": "string",
"description": "Operator kernel ID or wallet address"
}
}
}Get the latest camera frame from a kernel as a JSON snapshot (base64 JPEG + metadata). For raw JPEG image, use GET /api/ot2/camera/latest directly.
| Argument | Type | Description |
|---|---|---|
| kernelId* | string | Kernel ID to get camera frame from |
{
"type": "object",
"required": [
"kernelId"
],
"properties": {
"kernelId": {
"type": "string",
"description": "Kernel ID to get camera frame from"
}
}
}Cancel a capability request. Cancelled requests cannot be updated, decomposed, or published. This is a soft delete — the request remains visible with status 'cancelled'.
| Argument | Type | Description |
|---|---|---|
| requestId* | string | Request ID to cancel |
{
"type": "object",
"required": [
"requestId"
],
"properties": {
"requestId": {
"type": "string",
"description": "Request ID to cancel"
}
}
}Anchor a PASS + anchor-candidate capture verdict to CaptureClassRegistry on-chain (Base Sepolia by default). Rejects FAIL/PARTIAL verdicts. Idempotent — re-submitting the same verdictId returns the existing anchor row. Returns 202 {status:'deferred'} if CaptureClassRegistry is not yet deployed (CAPTURE_REGISTRY_ADDRESS unset).
| Argument | Type | Description |
|---|---|---|
| verdictId* | string | The verdictId returned by pcc_capture_upload. Must be a PASS verdict with anchorCandidate=true. |
{
"type": "object",
"required": [
"verdictId"
],
"properties": {
"verdictId": {
"type": "string",
"description": "The verdictId returned by pcc_capture_upload. Must be a PASS verdict with anchorCandidate=true."
}
}
}Issue a fresh block-anchored CaptureNonceChallenge for a job. The operator's device must render this nonce into the captured media (QR code, audio tone, etc.) before calling pcc_capture_upload. The nonce is derived from (challengeId, latest blockHash, workOutputRoot) so captures cannot be pre-computed. Returns challengeId, 64-char hex nonce, blockNumber, maxAgeSeconds (clamped to 120).
| Argument | Type | Description |
|---|---|---|
| jobId* | string | PCC job ID the capture belongs to |
| declaredClass* | string | Capture class the operator plans to claim. Determines which gates the verifier will run. |
| requestedTtlSeconds | integer | Requested challenge lifetime in seconds. Clamped to 120 server-side. |
{
"type": "object",
"required": [
"jobId",
"declaredClass"
],
"properties": {
"jobId": {
"type": "string",
"description": "PCC job ID the capture belongs to"
},
"declaredClass": {
"enum": [
"CC0",
"CC1",
"CC2",
"CC3",
"CC4",
"CC5"
],
"type": "string",
"description": "Capture class the operator plans to claim. Determines which gates the verifier will run."
},
"requestedTtlSeconds": {
"type": "integer",
"description": "Requested challenge lifetime in seconds. Clamped to 120 server-side."
}
}
}Look up a capture's on-chain anchor record in CaptureClassRegistry by its 32-byte captureHash. Returns the registry address, captureHash, and decoded anchor tuple (declaredClass, verifiedClass, manifestHash, submittedBy, jobId, challengeId, blockAnchor, capturedAt, attestationsRoot, attesterCount). onchain is null if the capture was never anchored. Returns 202 deferred when CaptureClassRegistry is not yet deployed.
| Argument | Type | Description |
|---|---|---|
| captureHash* | string | Capture hash (32-byte). Accepts 0x-prefixed or unprefixed hex, or sha256:<hex> format. Padded server-side to bytes32. |
{
"type": "object",
"required": [
"captureHash"
],
"properties": {
"captureHash": {
"type": "string",
"description": "Capture hash (32-byte). Accepts 0x-prefixed or unprefixed hex, or sha256:<hex> format. Padded server-side to bytes32."
}
}
}Fetch the combined verdict + on-chain anchor view for a single capture. Mirrors the verifier's DB shape plus the anchor tx metadata (txHash, blockNumber, gasUsed, explorerUrl). Anchor is null if the verdict was never anchored.
| Argument | Type | Description |
|---|---|---|
| verdictId* | string | Capture verdict UUID (from pcc_capture_upload). |
{
"type": "object",
"required": [
"verdictId"
],
"properties": {
"verdictId": {
"type": "string",
"description": "Capture verdict UUID (from pcc_capture_upload)."
}
}
}Upload a capture (photo / video / audio / sensor clip) with its CaptureManifest for G1..G6 verification. Bytes are base64-encoded inline; optional base64 C2PA manifest bytes can be supplied for CC3+ claims. The server runs the 6-gate CaptureVerifier and persists a PASS/PARTIAL/FAIL verdict. Returns {verdictId, verdict, verifiedClass, gatesPassed, gatesFailed, warnings, anchorCandidate, captureHash, manifestHash}.
| Argument | Type | Description |
|---|---|---|
| jobId | string | Job ID for telemetry binding. Falls back to manifest.jobId if omitted. |
| manifest* | object | CaptureManifest — ALCOA+-ready metadata: class, declaredAt (ISO-8601), deviceFingerprint, mediaHash (sha256:<hex>), optional challengeId. See CaptureManifestSchema in @pcc/spec. |
| operatorId | string | Explicit operator ID. Falls back to the authenticated session userId. |
| challengeId | string | Challenge UUID to re-bind to the in-memory challenge cache (G3 freshness gate). |
| submittedAt | integer | Client-submitted timestamp (epoch ms). Used in drift detection. |
| visualNonceEcho | string | The visual nonce value the operator rendered in-scene (QR payload, audio tone id, etc.). |
| c2paManifestBase64 | string | Optional base64-encoded C2PA manifest JUMBF bytes. Required when manifest.class >= CC3. |
Get chat history with a kernel. Returns messages between agents, operators, and users for a specific kernel.
| Argument | Type | Description |
|---|---|---|
| limit | number | Maximum messages to return (default 50) |
| kernelId* | string | Kernel ID to get chat history for |
{
"type": "object",
"required": [
"kernelId"
],
"properties": {
"limit": {
"type": "number",
"description": "Maximum messages to return (default 50)"
},
"kernelId": {
"type": "string",
"description": "Kernel ID to get chat history for"
}
}
}Send a chat message to a kernel's operator or agent. Used for human-in-the-loop communication during job execution, troubleshooting, and escalation.
| Argument | Type | Description |
|---|---|---|
| role | string | Sender role (default: user) |
| message* | string | Message content |
| kernelId* | string | Kernel ID to send the message to |
{
"type": "object",
"required": [
"kernelId",
"message"
],
"properties": {
"role": {
"enum": [
"user",
"agent",
"operator",
"system"
],
"type": "string",
"description": "Sender role (default: user)"
},
"message": {
"type": "string",
"description": "Message content"
},
"kernelId": {
"type": "string",
"description": "Kernel ID to send the message to"
}
}
}List all contributor profiles for an address across roles. Returns an array of {id, address, role, scheduleHash, ipId, contributorNftTokenId, metadataUri, registeredAt}. Returns empty array when no profiles exist for the address.
| Argument | Type | Description |
|---|---|---|
| address* | string | Wallet address (0x + 40 hex chars) |
{
"type": "object",
"required": [
"address"
],
"properties": {
"address": {
"type": "string",
"description": "Wallet address (0x + 40 hex chars)"
}
}
}Register a contributor profile binding a wallet address to a role and a published RateSchedule. Body: address (0x40hex), role (10 ContributorRole values from ADR-12 §2.1 + legacy 'designer'), scheduleHash (0x64hex of a previously published schedule), optional ipId, metadataUri, contributorNftTokenId. Returns the persisted profile (composite id is address:role:tail). Idempotent on the composite id — re-posting the same (address, role, contributorNftTokenId) replaces the prior profile.
| Argument | Type | Description |
|---|---|---|
| ipId | string | Optional Story Protocol IP Asset ID |
| role* | string | ContributorRole — 10 ADR-12 roles + deprecated 'designer' |
| address* | string | Wallet address (0x + 40 hex chars) |
| metadataUri | string | Optional ipfs:// or https:// URI |
| scheduleHash* | string | 0x + 64 hex sha256 of a published RateSchedule |
| contributorNftTokenId | string | Optional ContributorNFT tokenId once minted on-chain |
{
"type": "object",
"required": [
"address",
"role",
"scheduleHash"
],
"properties": {
"ipId": {
"type": "string",
"description": "Optional Story Protocol IP Asset ID"
},
"role": {
"enum": [
"operator",
"verifier",
"insurer",
"integrator",
"protocol-author",
"model-author",
"dataset-contributor",
"curator",
"assembler",
"network-treasury",
"designer"
],
"type": "string",
"description": "ContributorRole — 10 ADR-12 roles + deprecated 'designer'"
},
"address": {
"type": "string",
"description": "Wallet address (0x + 40 hex chars)"
},
"metadataUri": {
"type": "string",
"description": "Optional ipfs:// or https:// URI"
},
"scheduleHash": {
"type": "string",
"description": "0x + 64 hex sha256 of a published RateSchedule"
},
"contributorNftTokenId": {
"type": "string",
"description": "Optional ContributorNFT tokenId once minted on-chain"
}
}
}Create an execution scope for a job. Scopes define exactly which tool calls are allowed on a kernel during a job, with command budgets, retry limits, and time-to-live. Required before issuing SCOPED WRITE operations (protocol upload, run create, run action).
| Argument | Type | Description |
|---|---|---|
| jobId | string | Job ID this scope is bound to (optional) |
| kernelId* | string | Kernel ID to create the scope for |
| maxRetries | number | Maximum retries allowed (default 3) |
| ttlMinutes | number | Scope duration in minutes (default 30) |
| maxCommands | number | Maximum tool calls allowed in this scope (default 100) |
| allowedSlots | array | Which deck slots may be accessed (e.g. [1, 2, 3, 9]) |
| allowedTools* | array | List of tool names allowed in this scope (e.g. ['ot2_protocol_upload', 'ot2_run_create', 'ot2_run_action']) |
| protocolHash | string | SHA-256 hash of the approved protocol content. If set, protocol uploads are hash-verified. |
Re-trigger decomposition of an existing capability request. Overwrites the existing capability DAG with a fresh decomposition. Useful after updating the description or budget.
| Argument | Type | Description |
|---|---|---|
| requestId* | string | Request ID to decompose |
{
"type": "object",
"required": [
"requestId"
],
"properties": {
"requestId": {
"type": "string",
"description": "Request ID to decompose"
}
}
}Announce capabilities to the DHT network. Signs the announcement with your node's Ed25519 key and broadcasts to connected peers.
| Argument | Type | Description |
|---|---|---|
| kernelId* | string | Kernel ID announcing capabilities |
| ttlSeconds | number | How long the announcement is valid (default 300) |
| capabilities* | array | Array of capability summaries to announce |
{
"type": "object",
"required": [
"kernelId",
"capabilities"
],
"properties": {
"kernelId": {
"type": "string",
"description": "Kernel ID announcing capabilities"
},
"ttlSeconds": {
"type": "number",
"description": "How long the announcement is valid (default 300)"
},
"capabilities": {
"type": "array",
"items": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"description": "Capability type"
},
"materials": {
"type": "array",
"items": {
"type": "string"
}
},
"priceRange": {
"type": "object",
"properties": {
"max": {
"type": "number"
},
"min": {
"type": "number"
},
"currency": {
"type": "string"
}
}
},
"queueDepth": {
"type": "number"
}
}
},
"description": "Array of capability summaries to announce"
}
}
}Get a snapshot of DHT telemetry counters and recent events. Returns message counts, peer connection stats, query/announce rates, and a list of the last 50 metric events. Use for monitoring network health.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}List known DHT peers and their connection status. Shows which nodes are currently connected to the gossip network.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}Query the DHT for capabilities matching your requirements. Returns announcements from operators whose equipment matches the type, materials, and price range you specify.
| Argument | Type | Description |
|---|---|---|
| type | string | Capability type to search for (e.g. 'fdm_print', 'liquid-handler', 'cnc-3axis') |
| limit | number | Maximum results to return (default 10) |
| maxPrice | number | Maximum price per job — matches operators whose min price is at or below this |
| materials | array | Materials you need (matches if operator supports ANY of these) |
{
"type": "object",
"required": [],
"properties": {
"type": {
"type": "string",
"description": "Capability type to search for (e.g. 'fdm_print', 'liquid-handler', 'cnc-3axis')"
},
"limit": {
"type": "number",
"description": "Maximum results to return (default 10)"
},
"maxPrice": {
"type": "number",
"description": "Maximum price per job — matches operators whose min price is at or below this"
},
"materials": {
"type": "array",
"items": {
"type": "string"
},
"description": "Materials you need (matches if operator supports ANY of these)"
}
}
}Get a capability request by ID with the full decomposed DAG — all capability nodes, their dependencies, estimated costs/hours, assigned operators, and linked bounty IDs.
| Argument | Type | Description |
|---|---|---|
| requestId* | string | Request ID |
{
"type": "object",
"required": [
"requestId"
],
"properties": {
"requestId": {
"type": "string",
"description": "Request ID"
}
}
}Get the critical path (longest dependency chain) for a capability request. The critical path determines the minimum calendar time to complete the request. Returns node IDs in order, the full node details, and total hours on the critical path.
| Argument | Type | Description |
|---|---|---|
| requestId* | string | Request ID |
{
"type": "object",
"required": [
"requestId"
],
"properties": {
"requestId": {
"type": "string",
"description": "Request ID"
}
}
}Get the capability DAG (directed acyclic graph) for a request as adjacency data — nodes with all fields plus explicit edges showing dependency relationships. Useful for visualization or workflow planning.
| Argument | Type | Description |
|---|---|---|
| requestId* | string | Request ID |
{
"type": "object",
"required": [
"requestId"
],
"properties": {
"requestId": {
"type": "string",
"description": "Request ID"
}
}
}Get the tool manifest for a kernel's device type. Lists all available tools with their safety classification (read, safe_control, scoped_write, privileged) and input schemas. Use to understand what tools are available before making tool calls.
| Argument | Type | Description |
|---|---|---|
| kernelId* | string | Kernel ID |
{
"type": "object",
"required": [
"kernelId"
],
"properties": {
"kernelId": {
"type": "string",
"description": "Kernel ID"
}
}
}Get the result of a previously relayed tool call. Poll this endpoint until the executor has processed the call and posted results.
| Argument | Type | Description |
|---|---|---|
| callId* | string | Tool call ID returned from pcc_relay_tool_call |
{
"type": "object",
"required": [
"callId"
],
"properties": {
"callId": {
"type": "string",
"description": "Tool call ID returned from pcc_relay_tool_call"
}
}
}Complete a job: gathers tool call audit trail from execution scopes, builds evidence bundle with SHA-256 hash, stores evidence, revokes scopes, and settles escrow (mock or real). This is how a job run through execution scopes is finished. A node that submitted its evidence and set status completed (operator_update_job_status) must not call it: it then answers 409 ("Job already completed or completion in progress").
| Argument | Type | Description |
|---|---|---|
| jobId* | string | Job ID to complete |
| message | string | Completion message or notes |
{
"type": "object",
"required": [
"jobId"
],
"properties": {
"jobId": {
"type": "string",
"description": "Job ID to complete"
},
"message": {
"type": "string",
"description": "Completion message or notes"
}
}
}Get a job's settlement status from its own escrow records: status (settled only when a settlement read confirms the release; reported_released when the milestone record says released but nothing confirms it; simulated for a mock escrow; awaiting_settlement, no_settlement_record, unknown or unavailable otherwise), settled, payout, paidAmount (confirmed releases only), reportedReleasedAmount, quotedAmount, currency (recorded or null), escrow, milestones, the negotiation session, notices and asOf.
| Argument | Type | Description |
|---|---|---|
| jobId* | string | Job ID |
{
"type": "object",
"required": [
"jobId"
],
"properties": {
"jobId": {
"type": "string",
"description": "Job ID"
}
}
}List all capability requests with optional filtering. Shows status, decomposed DAG summary, estimated costs, and timelines.
| Argument | Type | Description |
|---|---|---|
| status | string | Filter by status |
| urgency | string | Filter by urgency |
| requesterEmail | string | Filter by requester email |
{
"type": "object",
"required": [],
"properties": {
"status": {
"enum": [
"draft",
"decomposing",
"published",
"in_progress",
"completed",
"cancelled"
],
"type": "string",
"description": "Filter by status"
},
"urgency": {
"enum": [
"standard",
"rush",
"emergency"
],
"type": "string",
"description": "Filter by urgency"
},
"requesterEmail": {
"type": "string",
"description": "Filter by requester email"
}
}
}List recent capture verdicts, newest first. Optionally filter by jobId. Default limit is 50, capped at 200 server-side. Returns {verdicts, count, limit, jobId}.
| Argument | Type | Description |
|---|---|---|
| jobId | string | Filter by job ID. Omit for all verdicts across jobs. |
| limit | integer | Maximum rows returned (default 50, hard cap 200). |
{
"type": "object",
"required": [],
"properties": {
"jobId": {
"type": "string",
"description": "Filter by job ID. Omit for all verdicts across jobs."
},
"limit": {
"type": "integer",
"description": "Maximum rows returned (default 50, hard cap 200)."
}
}
}Finalise a physical-operator onboarding session: registers the operator on PCC, mints a wallet, writes the SEO mirror, returns the publication payload (capabilities, operator_id, discovery_url). Idempotent — safe to retry inside the same session_id. Auth-required.
| Argument | Type | Description |
|---|---|---|
| id* | string | Session id returned by pcc_onboard_session_start. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Session id returned by pcc_onboard_session_start."
}
}
}Queue documents (datasheets, SOPs, MOPs, certifications) for ingestion into a physical-operator onboarding session. Document URLs may be local:// for files dropped in the chat console or full https:// URLs. Auth-required.
| Argument | Type | Description |
|---|---|---|
| id* | string | Session id returned by pcc_onboard_session_start. |
| doc_urls* | array | URLs of documents to ingest. Mix of local:// and https:// is fine. |
{
"type": "object",
"required": [
"id",
"doc_urls"
],
"properties": {
"id": {
"type": "string",
"description": "Session id returned by pcc_onboard_session_start."
},
"doc_urls": {
"type": "array",
"items": {
"type": "string"
},
"description": "URLs of documents to ingest. Mix of local:// and https:// is fine."
}
}
}Full event log for a physical-operator onboarding session — feeds the chat console's activity sidebar. Supports incremental polling via ?since=<unix-millis>. Returns the next cursor on every response. Auth-required.
| Argument | Type | Description |
|---|---|---|
| id* | string | Session id returned by pcc_onboard_session_start. |
| since | number | Unix milliseconds cursor — returns only events with t > since. Use the 'cursor' field of the previous response for incremental polling. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Session id returned by pcc_onboard_session_start."
},
"since": {
"type": "number",
"description": "Unix milliseconds cursor — returns only events with t > since. Use the 'cursor' field of the previous response for incremental polling."
}
}
}Scrape a URL into the running physical-operator onboarding session. Triggers a stealth fetch + structured extraction (machines, hours, services, certifications). Returns a small JSON summary; full extraction is appended to the session's running profile and visible via /live-data. Auth-required.
| Argument | Type | Description |
|---|---|---|
| id* | string | Session id returned by pcc_onboard_session_start. |
| url* | string | URL to scrape (e.g. company About page). |
{
"type": "object",
"required": [
"id",
"url"
],
"properties": {
"id": {
"type": "string",
"description": "Session id returned by pcc_onboard_session_start."
},
"url": {
"type": "string",
"description": "URL to scrape (e.g. company About page)."
}
}
}Start a new physical-operator onboarding session. Returns a session_id used by every subsequent /api/onboard/* call. Auth-required.
| Argument | Type | Description |
|---|---|---|
| url | string | Optional company website. If supplied, the orchestrator scrapes it on the next /scrape call. |
| name* | string | Operator / company name (e.g. 'Oakland Titanium Mills'). |
{
"type": "object",
"required": [
"name"
],
"properties": {
"url": {
"type": "string",
"description": "Optional company website. If supplied, the orchestrator scrapes it on the next /scrape call."
},
"name": {
"type": "string",
"description": "Operator / company name (e.g. 'Oakland Titanium Mills')."
}
}
}Coarse status snapshot for a physical-operator onboarding session: current state, 0-100 progress, scraped_count, ingested_count, last_event, publication payload (if built). Cheap — designed for polling from the chat header. Auth-required.
| Argument | Type | Description |
|---|---|---|
| id* | string | Session id returned by pcc_onboard_session_start. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Session id returned by pcc_onboard_session_start."
}
}
}Not served by the PCC gateway: GET /api/oracle/health returns 404 there. PCC's verification oracle runs as a separate service, and this route answers only where a deployment fronts it. Agents never call the oracle to settle a job: settlement is the gateway's step after pcc_job_complete. Where it is served, it returns the oracle's EIP-712 signing address and chain ID.
No arguments.
{
"type": "object",
"properties": {}
}Not served by the PCC gateway: POST /api/oracle/verify returns 404 there. PCC's verification oracle runs as a separate service, and this route answers only where a deployment fronts it. Agents never call it to settle a job: settlement is the gateway's step after pcc_job_complete. Where it is served, it checks that the evidence exists, its hash matches, tier requirements are met, there is no replay and the operator identity is valid, and it returns a signed EIP-712 attestation.
| Argument | Type | Description |
|---|---|---|
| jobId* | string | PCC job ID |
| kernelId* | string | Operator kernel ID |
| evidenceHash* | string | SHA-256 hash of evidence bundle |
| assuranceTier | integer | Evidence tier (0=none, 1=basic, 2=full, 3=ZK) |
| escrowAddress* | string | Escrow contract address |
{
"type": "object",
"required": [
"escrowAddress",
"jobId",
"kernelId",
"evidenceHash"
],
"properties": {
"jobId": {
"type": "string",
"description": "PCC job ID"
},
"kernelId": {
"type": "string",
"description": "Operator kernel ID"
},
"evidenceHash": {
"type": "string",
"description": "SHA-256 hash of evidence bundle"
},
"assuranceTier": {
"enum": [
0,
1,
2,
3
],
"type": "integer",
"description": "Evidence tier (0=none, 1=basic, 2=full, 3=ZK)"
},
"escrowAddress": {
"type": "string",
"description": "Escrow contract address"
}
}
}List the orchestrator templates the dashboard's chat console can drive. Each entry includes slug, display_name, description, produces_kind, capability_class (physical | digital), greeting, and api_base (the route prefix that serves the six session-driver routes for that template). Public — no auth required.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}Heuristic template matcher. Pass a free-text description of what you want to onboard (e.g. 'I run a CNC milling shop' or 'I have a Postgres database with a GraphQL endpoint') and the matcher returns all templates ranked by keyword score with a 'reason' string per match. Public — no auth required.
| Argument | Type | Description |
|---|---|---|
| input* | string | Free-text description of what you want to onboard. |
{
"type": "object",
"required": [
"input"
],
"properties": {
"input": {
"type": "string",
"description": "Free-text description of what you want to onboard."
}
}
}Get the current protocol fee rate (2.35%, immutable) and fee recipient address. The fee is hardcoded in the PCCProtocol smart contract — no admin, no governance, no upgrade can change it.
No arguments.
{
"type": "object",
"properties": {}
}Publish all pending capability nodes in a request as bounties. Each node becomes a bidding opportunity for operators. Returns the list of created bounty IDs linked to each capability node.
| Argument | Type | Description |
|---|---|---|
| requestId* | string | Request ID to publish |
{
"type": "object",
"required": [
"requestId"
],
"properties": {
"requestId": {
"type": "string",
"description": "Request ID to publish"
}
}
}Relay a tool call to any kernel's device executor via the generic relay (not OT-2 specific). Works with any device type. Safe tools (read/safe_control) don't need a scope. Scoped write tools require an active execution scope. Returns a call ID — poll pcc_get_tool_result for the response.
| Argument | Type | Description |
|---|---|---|
| args | object | Tool arguments |
| scopeId | string | Execution scope ID (required for write operations) |
| kernelId* | string | Target kernel ID |
| toolName* | string | Tool name from the device manifest |
{
"type": "object",
"required": [
"kernelId",
"toolName"
],
"properties": {
"args": {
"type": "object",
"description": "Tool arguments"
},
"scopeId": {
"type": "string",
"description": "Execution scope ID (required for write operations)"
},
"kernelId": {
"type": "string",
"description": "Target kernel ID"
},
"toolName": {
"type": "string",
"description": "Tool name from the device manifest"
}
}
}Relay a tool call to a device executor. The brain (LLM) posts tool calls here; the executor (on the device) polls for them and executes locally. Used for the brain/executor split architecture.
| Argument | Type | Description |
|---|---|---|
| scopeId | string | Execution scope ID (required for SCOPED WRITE tools) |
| kernelId* | string | Kernel ID of the target device |
| toolArgs* | object | Arguments for the tool call |
| toolName* | string | Tool to execute (e.g. 'ot2_health', 'ot2_run_create') |
{
"type": "object",
"required": [
"kernelId",
"toolName",
"toolArgs"
],
"properties": {
"scopeId": {
"type": "string",
"description": "Execution scope ID (required for SCOPED WRITE tools)"
},
"kernelId": {
"type": "string",
"description": "Kernel ID of the target device"
},
"toolArgs": {
"type": "object",
"description": "Arguments for the tool call"
},
"toolName": {
"type": "string",
"description": "Tool to execute (e.g. 'ot2_health', 'ot2_run_create')"
}
}
}Report a bug, friction, or dead-end you hit while using PCC. Call this the moment you get stuck and cannot recover: a 5xx (its response carries a `report_hint` with pre-filled fields), a 4xx you cannot fix from its message, the same step failing twice, or a misleading tool/description. PUBLIC — works before you provision an API key (cold agents are exactly who this is for). Persisted durably and reviewed by the PCC team. Report each distinct failure ONCE; never include an API key, token, or wallet secret. Rate-limited per IP.
| Argument | Type | Description |
|---|---|---|
| logs | array | Optional but valuable: your last few steps as SUMMARIES (never full request/response bodies) — the sequence that led to the failure. Secrets are never allowed in a note. |
| type | string | bug = something is broken/wrong; friction = it works but was confusing/harder than it should be; idea = a suggestion or missing capability. Defaults to bug. |
| detail | string | Multi-line context: the full error body, what you tried, what you expected. Optional but recommended. |
| method | string | The HTTP method you used. From `report_hint.send.method`. Example: 'POST'. |
| status | integer | The HTTP status you got. From `report_hint.send.status`. Example: 500. |
| agentId | string | Which model/agent you are. Example: 'claude', 'gpt-4o', 'gemini'. Optional. |
| summary* |
Report one phase of an onboarding attempt, success or failure (attempt reporting contract v1). Send one report when each runbook phase ends, and a final report with phase "session" (with the `phases` roll-up), also when you stop early (outcome abandoned or budget_stop). Generate `sessionId` (UUID v4) once per attempt and increment `seq` with every report; a retried report with the same sessionId and seq is collapsed. Never guess: send null for what you do not know (tokens: source "unknown"). Redact keys, tokens, emails and wallet secrets before sending. Always include `summary`: contract v1 makes it optional, but until the gateway's attempt support lands it is the only field kept, and today's server refuses a report without it. The schema is contract v1: an unknown phase, outcome or harness name is accepted (the server stores it as other or unknown, with the raw value as a label), and budget-stop is a spelling of budget_stop. Never send a transcript; consent.transcript stays false until the operator decides. Unauthenticated.
| Argument | Type | Description |
|---|---|---|
| env | object | null | |
| ids | object | null | Only the ids known so far: each at most 200 characters of [A-Za-z0-9:._/-], or null |
| seq* | integer | Per-session report counter |
| kind* | string | |
| logs | array | null | The phase's step timeline, summaries only |
| pack | object | null |
Revoke an execution scope immediately (emergency stop). All pending tool calls under this scope are rejected. The kernel enters a stopped state. A new scope must be created to resume.
| Argument | Type | Description |
|---|---|---|
| scopeId* | string | Scope ID to revoke |
{
"type": "object",
"required": [
"scopeId"
],
"properties": {
"scopeId": {
"type": "string",
"description": "Scope ID to revoke"
}
}
}Evaluate a published RateSchedule at a moment, returning the effective bps. Inputs: scheduleHash + now (unix seconds) + optional jobValueCents (piecewise-value) + optional jobsPerDay (adoption-indexed). Returns {scheduleHash, bps, segmentKind, segmentIndex}. segmentIndex=-1 + bps=0 when no segment covers the moment (silent gap).
| Argument | Type | Description |
|---|---|---|
| now* | integer | Unix seconds at evaluation moment |
| jobsPerDay | number | Rolling 24h job count (adoption-indexed segments) |
| scheduleHash* | string | 0x + 64 hex schedule hash |
| jobValueCents | integer | Job value in cents (piecewise-value segments) |
{
"type": "object",
"required": [
"scheduleHash",
"now"
],
"properties": {
"now": {
"type": "integer",
"minimum": 0,
"description": "Unix seconds at evaluation moment"
},
"jobsPerDay": {
"type": "number",
"minimum": 0,
"description": "Rolling 24h job count (adoption-indexed segments)"
},
"scheduleHash": {
"type": "string",
"description": "0x + 64 hex schedule hash"
},
"jobValueCents": {
"type": "integer",
"minimum": 0,
"description": "Job value in cents (piecewise-value segments)"
}
}
}Fetch a published RateSchedule by its content hash. Returns {schedule, publishedBy} with segments re-validated via Zod, or 404 if not found.
| Argument | Type | Description |
|---|---|---|
| scheduleHash* | string | 0x + 64 hex sha256 of the schedule |
{
"type": "object",
"required": [
"scheduleHash"
],
"properties": {
"scheduleHash": {
"type": "string",
"description": "0x + 64 hex sha256 of the schedule"
}
}
}Publish a sealed off-chain RateSchedule. Computes scheduleHash server-side via the canonical sha256-over-canonical-JSON algorithm (matching the on-chain RateScheduleRegistry.publish() invariant). Idempotent: re-publishing the same content returns alreadyPublished:true. Returns {scheduleHash, alreadyPublished}.
| Argument | Type | Description |
|---|---|---|
| schedule* | object | RateSchedule body — version, segments (constant/step/linear-decay/exponential-decay/adoption-indexed/piecewise-value), and optional notes |
| publishedBy* | string | Address that publishes (0x + 40 hex chars) |
{
"type": "object",
"required": [
"publishedBy",
"schedule"
],
"properties": {
"schedule": {
"type": "object",
"required": [
"version",
"segments"
],
"properties": {
"notes": {
"type": "string"
},
"version": {
"type": "integer",
"minimum": 1
},
"segments": {
"type": "array",
"items": {
"type": "object"
},
"minItems": 1
}
},
"description": "RateSchedule body — version, segments (constant/step/linear-decay/exponential-decay/adoption-indexed/piecewise-value), and optional notes"
},
"publishedBy": {
"type": "string",
"description": "Address that publishes (0x + 40 hex chars)"
}
}
}Get the audit trail for an execution scope — every tool call made under this scope, with validation results, timestamps, and outcomes.
| Argument | Type | Description |
|---|---|---|
| scopeId* | string | Scope ID to audit |
{
"type": "object",
"required": [
"scopeId"
],
"properties": {
"scopeId": {
"type": "string",
"description": "Scope ID to audit"
}
}
}Fast-track paid job: one call from DHT discovery to funded escrow + active scope. Auto-negotiates, quotes, creates escrow with milestones, creates execution scope. Returns jobId, scopeId, escrowId, quote with pricing adjustments, contract terms. For testnet, escrow is mock-funded automatically.
| Argument | Type | Description |
|---|---|---|
| kernelId* | string | Target kernel ID (from DHT query) |
| parameters | object | Job parameters (protocolType, volume, materials, etc.) |
| userAgentId* | string | Your agent/user ID |
| paymentMethod | string | Payment method (testnet-mock for demo) |
| capabilityType* | string | e.g. 'liquid-handler', 'fdm', 'cnc-3axis' |
{
"type": "object",
"required": [
"kernelId",
"capabilityType",
"userAgentId"
],
"properties": {
"kernelId": {
"type": "string",
"description": "Target kernel ID (from DHT query)"
},
"parameters": {
"type": "object",
"description": "Job parameters (protocolType, volume, materials, etc.)"
},
"userAgentId": {
"type": "string",
"description": "Your agent/user ID"
},
"paymentMethod": {
"enum": [
"escrow",
"testnet-mock"
],
"type": "string",
"description": "Payment method (testnet-mock for demo)"
},
"capabilityType": {
"type": "string",
"description": "e.g. 'liquid-handler', 'fdm', 'cnc-3axis'"
}
}
}Submit a high-level capability request in natural language. The system automatically decomposes it into a capability DAG with dependencies, timelines, and budget allocation across fabrication, design, assembly, electronics, software, logistics, and verification nodes. Returns the request with full decomposed DAG. Example: 'Build a cute animatronic plush desk robot with servo-driven animations'.
| Argument | Type | Description |
|---|---|---|
| title* | string | Short title for the request |
| budget | number | Total budget in USDC (default: 1000) |
| urgency | string | Urgency level — affects cost multipliers (emergency: 2x cost, 0.5x time) |
| currency | string | Currency (default: USDC) |
| deadline | string | ISO 8601 deadline (default: 7 days from now) |
| description* | string | Full natural language description of what needs to be built or done |
| requesterEmail | string | Requester email for notifications |
| requesterWallet | string | Requester wallet address for payments |
Fetch the TrainingManifest for a model IP. Returns the parsed datasets array + manifestHash + createdAt, or 404 if no manifest has been set.
| Argument | Type | Description |
|---|---|---|
| modelIpId* | string | Story IP Asset ID for the model |
{
"type": "object",
"required": [
"modelIpId"
],
"properties": {
"modelIpId": {
"type": "string",
"description": "Story IP Asset ID for the model"
}
}
}Set (insert-or-replace) the TrainingManifest for a model IP — the dataset weight map the LicensingEngine walks when distributing payouts to a 'model-author' entry in a CompositionManifest. Dataset weightBps must sum to ≤ 10000 (gateway accepts partial mixes; on-chain enforces exact 10000). Returns {modelIpId, manifestHash}.
| Argument | Type | Description |
|---|---|---|
| modelIpId* | string | Story IP Asset ID for the model |
| baseModelIpId | string | Optional parent ModelNFT IP if this was fine-tuned |
| datasetWeights* | array | DatasetIP entries with weightBps (sum ≤ 10000) |
| methodologyHash | string | Optional 0x + 64 hex reproducibility hash |
{
"type": "object",
"required": [
"modelIpId",
"datasetWeights"
],
"properties": {
"modelIpId": {
"type": "string",
"description": "Story IP Asset ID for the model"
},
"baseModelIpId": {
"type": "string",
"description": "Optional parent ModelNFT IP if this was fine-tuned"
},
"datasetWeights": {
"type": "array",
"items": {
"type": "object",
"required": [
"datasetIpId",
"weightBps"
],
"properties": {
"weightBps": {
"type": "integer",
"maximum": 10000,
"minimum": 0
},
"datasetIpId": {
"type": "string"
},
"dataPointCount": {
"type": "integer",
"minimum": 0
}
}
},
"minItems": 1,
"description": "DatasetIP entries with weightBps (sum ≤ 10000)"
},
"methodologyHash": {
"type": "string",
"description": "Optional 0x + 64 hex reproducibility hash"
}
}
}Generate a complete KERNEL_CONFIG JSON for a Trilobio (tcode-api) fleet controller. Wraps `buildTrilobioConfig()` from the @pcc/trilobio npm package. Returns a TrilobioKernelConfig with sensible defaults (pollIntervalMs=3000, maxScriptTimeoutSec=3600, allowArbitraryScripts=false). The result can be passed to `pcc-node start` via the KERNEL_CONFIG env var, or handed to setup_generate_config / setup_register_device for direct API-driven registration. Note: this is a TypeScript package helper (no HTTP call). For programmatic use, `import { buildTrilobioConfig } from "@pcc/trilobio"`.
| Argument | Type | Description |
|---|---|---|
| url* | string | Fleet-controller URL on the LAN (host[:port], no trailing slash, no path) — e.g. http://192.168.1.50 |
| apiKey | string | Trilobio fleet-controller API key (from the trilobot admin UI). Either apiKey OR username+password is required unless mockMode=true. |
| deviceId | string | Logical device ID within the kernel (default: trilobio-fleet-01) |
| kernelId | string | Kernel ID this device belongs to (auto-generated as kernel_trilobio_<timestamp> if omitted) |
| mockMode | boolean | Bypass real HTTP and simulate runs. Use for CI / floor demos. Default: false. |
| password | string | Fleet-controller account password (basic-auth mode only) |
| username |
Return the `TRILOBIO_CAPABILITY` constant from @pcc/trilobio — a default capability template for a Trilobio fleet controller. Pass to POST /api/capabilities to publish a baseline liquid-handling capability for a kernel hosting a trilobot. Operators can extend the `materials` and `capabilities` arrays to advertise instrument-specific features (custom labware libraries, sample types). Notable: includes `tcode-script-execution` as an advertised capability, which is unique to Trilobio — operators who set `allowArbitraryScripts: true` can accept jobs that ship a full tcode-api Python script as the protocol payload. Note: TypeScript package helper (no HTTP call); for programmatic use, `import { TRILOBIO_CAPABILITY } from "@pcc/trilobio"`.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}Sanity-check operator-supplied Trilobio options before generating a KERNEL_CONFIG. Wraps `validateTrilobioOptions()` from @pcc/trilobio. Catches the common mistakes (malformed URL, missing creds, out-of-range timeouts, invalid tcodeApiVersion semver) before they hit the gateway or the device. Returns { valid: boolean, errors: string[], warnings?: string[] }. Note: this is a TypeScript package helper (no HTTP call); for programmatic use, `import { validateTrilobioOptions } from "@pcc/trilobio"`.
| Argument | Type | Description |
|---|---|---|
| url | string | Fleet-controller URL |
| apiKey | string | Fleet-controller API key |
| deviceId | string | |
| kernelId | string | |
| mockMode | boolean | |
| password | string | Basic-auth password |
| username | string | Basic-auth username |
| pollIntervalMs | number | |
| tcodeApiVersion | string | 'latest' or semver string |
Quick lint of a tcode-api Python script before submission to a Trilobio fleet controller. Wraps `validateTcodeScript()` from @pcc/trilobio. Surface check only — NOT a sandbox or sanitizer. Looks for: imports of `tcode_api` (presence required), obviously dangerous statements (subprocess, os.system, eval, exec, __import__, socket, urllib, requests, file writes), empty scripts, and missing top-level tcode commands. Returns { valid: boolean, errors: string[], warnings?: string[] }. Operators with `allowArbitraryScripts=true` should treat results as a hint — the fleet controller is the source of truth on safety. Note: TypeScript package helper (no HTTP call); for programmatic use, `import { validateTcodeScript } from "@pcc/trilobio"`.
| Argument | Type | Description |
|---|---|---|
| source* | string | Full Python source of the tcode-api script to lint |
{
"type": "object",
"required": [
"source"
],
"properties": {
"source": {
"type": "string",
"description": "Full Python source of the tcode-api script to lint"
}
}
}Update the status of a capability node within a request. Valid transitions: pending → bidding → assigned → in_progress → completed (or failed). When all nodes complete, the request automatically moves to completed.
| Argument | Type | Description |
|---|---|---|
| nodeId* | string | Capability node ID |
| status* | string | New status for the node |
| requestId* | string | Request ID |
{
"type": "object",
"required": [
"requestId",
"nodeId",
"status"
],
"properties": {
"nodeId": {
"type": "string",
"description": "Capability node ID"
},
"status": {
"enum": [
"pending",
"bidding",
"assigned",
"in_progress",
"completed",
"failed"
],
"type": "string",
"description": "New status for the node"
},
"requestId": {
"type": "string",
"description": "Request ID"
}
}
}Update a capability request's title, description, budget, deadline, urgency, or contact info. Does not re-decompose — call pcc_decompose_request afterwards if you want a fresh DAG.
| Argument | Type | Description |
|---|---|---|
| title | string | |
| budget | number | |
| urgency | string | |
| deadline | string | |
| requestId* | string | Request ID |
| description | string | |
| requesterEmail | string | |
| requesterWallet | string |
{
"type": "object",
"required": [
"requestId"
],
"properties": {
"title": {
"type": "string"
},
"budget": {
"type": "number"
},
"urgency": {
"enum": [
"standard",
"rush",
"emergency"
],
"type": "string"
},
"deadline": {
"type": "string"
},
"requestId": {
"type": "string",
"description": "Request ID"
},
"description": {
"type": "string"
},
"requesterEmail": {
"type": "string"
},
"requesterWallet": {
"type": "string"
}
}
}Report CaptureVerifier health: which adapters are loaded (c2pa, webauthn, appattest, playintegrity), their staleness status, in-memory challenge cache size, whether CaptureClassRegistry is deployed, and the active PCC_NETWORK. Use this to diagnose why a capture class is being rejected or degraded.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}Propose a composition — a sequenced DAG of capability instances to satisfy a multi-step outcome under a budget + assurance tier. Accepts either a flat `steps` list or an outcome chain. Returns a candidate plan ranked by `optimizeFor` (price | speed | quality) with per-step assignments. The composition is persisted for ~30 minutes (proposed status) and can be executed once via execute_composition.
| Argument | Type | Description |
|---|---|---|
| steps | array | Ordered list of capability types this composition needs (1..20). Use this OR `outcomeChain`. |
| location | object | Geographic constraint (lat/lng + radius, or country, etc). |
| budgetUSD* | number | Total budget the user is willing to spend across all steps. |
| requester | object | {agentId, did?} — the agent submitting the request. |
| description | string | Free-form natural-language description (≤4000 chars). |
| optimizeFor | string | Ranking objective (default `price`). |
| outcomeType* | string | High-level outcome label, ≤120 chars. Example: 'desk-robot-prototype'. |
| outcomeChain | array |
Create a new MilestoneEscrow contract via the PCCProtocol factory on-chain. Protocol-deployed escrows have fee collection and registry tracking built in. Requires PCC_GATEWAY_PRIVATE_KEY write access.
| Argument | Type | Description |
|---|---|---|
| cwmId* | string | Capability Work Module ID as a 32-byte hex string (0x + 64 chars) |
| payer* | string | Payer EVM address (0x...) |
| token* | string | ERC-20 token address for payment (0x...) |
| arbiter* | string | Arbiter EVM address (0x...) — resolves disputes |
{
"type": "object",
"required": [
"payer",
"arbiter",
"token",
"cwmId"
],
"properties": {
"cwmId": {
"type": "string",
"description": "Capability Work Module ID as a 32-byte hex string (0x + 64 chars)"
},
"payer": {
"type": "string",
"description": "Payer EVM address (0x...)"
},
"token": {
"type": "string",
"description": "ERC-20 token address for payment (0x...)"
},
"arbiter": {
"type": "string",
"description": "Arbiter EVM address (0x...) — resolves disputes"
}
}
}Get protocol fees collected from a specific escrow contract. Also returns whether the escrow was deployed via the protocol factory. Useful for auditing fee flows.
| Argument | Type | Description |
|---|---|---|
| escrowAddress* | string | Escrow contract address (0x...) |
{
"type": "object",
"required": [
"escrowAddress"
],
"properties": {
"escrowAddress": {
"type": "string",
"description": "Escrow contract address (0x...)"
}
}
}Calculate the protocol fee for a given USDC amount (6-decimal units). Returns the fee, the net amount after fee, and formatted versions of both. Use this before building escrow contracts to understand the true cost.
| Argument | Type | Description |
|---|---|---|
| amount* | string | Amount as a BigInt string in USDC 6-decimal units (e.g. '1000000000' = 1000 USDC) |
{
"type": "object",
"required": [
"amount"
],
"properties": {
"amount": {
"type": "string",
"description": "Amount as a BigInt string in USDC 6-decimal units (e.g. '1000000000' = 1000 USDC)"
}
}
}Read the PCCProtocol root contract state: current fee rate, total protocol fees collected, total escrow count, and registry addresses. Requires PCC_PROTOCOL_ADDRESS to be configured on the gateway.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}Get total protocol fees collected for a specific ERC-20 token address across all escrows. Returns raw wei amount and human-readable formatted value.
| Argument | Type | Description |
|---|---|---|
| tokenAddress* | string | ERC-20 token contract address (0x...) |
{
"type": "object",
"required": [
"tokenAddress"
],
"properties": {
"tokenAddress": {
"type": "string",
"description": "ERC-20 token contract address (0x...)"
}
}
}Fast-track: submit evidence that your device works and get auto-approved + activated immediately. No manual review needed. Submit a photo of test output, device health snapshot, or a full evidence bundle with completion events. If evidence meets requirements, registration jumps straight to 'active'.
| Argument | Type | Description |
|---|---|---|
| evidence* | object | Evidence proving the device works. Include at least one of: bundleHash+events, photoBase64, or deviceHealth. |
| registrationId* | string | Registration ID to prove |
{
"type": "object",
"required": [
"registrationId",
"evidence"
],
"properties": {
"evidence": {
"type": "object",
"properties": {
"events": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Event type: execution_completed, camera_snapshot, power_profile_summary, etc."
},
"payload": {
"type": "object",
"description": "Event data"
},
"timestamp": {
"type": "string",
"description": "ISO timestamp"
}
}
},
"description": "Evidence events from a test job"
},
"ipfsCid": {
"type": "string",
"description": "IPFS CID if evidence was already uploaded"
},
"bundleHash": {
"type": "string",
"description": "SHA-256 hash of the evidence bundle"
},
"photoBase64": {
"type": "string",
"description": "Base64-encoded photo of test output (printed page, machined part, etc.)"
},
"deviceHealth": {
"type": "object",
"properties": {
"model": {
"type": "string",
"description": "Device model name"
},
"status": {
"type": "string",
"description": "Device status (e.g. 'idle', 'ready')"
},
"firmware": {
"type": "string",
"description": "Firmware version"
}
},
"description": "Live device health snapshot"
}
},
"description": "Evidence proving the device works. Include at least one of: bundleHash+events, photoBase64, or deviceHealth."
},
"registrationId": {
"type": "string",
"description": "Registration ID to prove"
}
}
}CALL THIS FIRST. Provisions an API key for the operator. Returns a pcc_live_* key that must be included as 'Authorization: Bearer <key>' on all subsequent requests. Accepts either email OR walletAddress. The key is shown once — save it. Without it, all other endpoints return 401.
| Argument | Type | Description |
|---|---|---|
| name | string | Operator display name (optional) |
| string | Operator email address (use this OR walletAddress) | |
| capability | string | What the operator does — e.g. 'FDM 3D printing', 'CNC milling', 'HPLC analysis' |
| walletAddress | string | EVM wallet address (use this OR email) |
{
"type": "object",
"required": [],
"properties": {
"name": {
"type": "string",
"description": "Operator display name (optional)"
},
"email": {
"type": "string",
"description": "Operator email address (use this OR walletAddress)"
},
"capability": {
"type": "string",
"description": "What the operator does — e.g. 'FDM 3D printing', 'CNC milling', 'HPLC analysis'"
},
"walletAddress": {
"type": "string",
"description": "EVM wallet address (use this OR email)"
}
}
}Publish a draft protocol template, making it visible in the protocol library for others to discover and use.
| Argument | Type | Description |
|---|---|---|
| id* | string | Protocol template ID to publish |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Protocol template ID to publish"
}
}
}Raise a Story Protocol IP dispute against an asset. Provide evidence hash and reason.
| Argument | Type | Description |
|---|---|---|
| ipId* | string | IP asset ID to dispute |
| reason* | string | Reason for the dispute |
| evidenceHash* | string | Hash of the dispute evidence |
{
"type": "object",
"required": [
"ipId",
"evidenceHash",
"reason"
],
"properties": {
"ipId": {
"type": "string",
"description": "IP asset ID to dispute"
},
"reason": {
"type": "string",
"description": "Reason for the dispute"
},
"evidenceHash": {
"type": "string",
"description": "Hash of the dispute evidence"
}
}
}Record a transfer episode for a node pair. Increments episode count toward VLA training threshold.
| Argument | Type | Description |
|---|---|---|
| success | boolean | Whether the episode succeeded |
| toNodeId* | string | Destination instrument node ID |
| episodeId | string | Episode ID (optional) |
| fromNodeId* | string | Source instrument node ID |
{
"type": "object",
"required": [
"fromNodeId",
"toNodeId"
],
"properties": {
"success": {
"type": "boolean",
"description": "Whether the episode succeeded"
},
"toNodeId": {
"type": "string",
"description": "Destination instrument node ID"
},
"episodeId": {
"type": "string",
"description": "Episode ID (optional)"
},
"fromNodeId": {
"type": "string",
"description": "Source instrument node ID"
}
}
}One-click agent onboarding with an invite code. Provisions wallet, identity, LLM access, and PCC tools in a single call.
| Argument | Type | Description |
|---|---|---|
| name | string | Display name (optional) |
| email* | string | Email address for the account |
| password* | string | Password for the account |
| inviteCode* | string | Invite code to redeem |
{
"type": "object",
"required": [
"inviteCode",
"email",
"password"
],
"properties": {
"name": {
"type": "string",
"description": "Display name (optional)"
},
"email": {
"type": "string",
"description": "Email address for the account"
},
"password": {
"type": "string",
"description": "Password for the account"
},
"inviteCode": {
"type": "string",
"description": "Invite code to redeem"
}
}
}Register a capability as a Story Protocol IP Asset. Returns an ipId and NFT token. The designer earns royalties whenever this capability is used.
| Argument | Type | Description |
|---|---|---|
| ipfsCid | string | IPFS CID of the capability spec document (optional) |
| capability* | object | Capability object |
| designerName* | string | Display name of the designer |
| designerAddress* | string | EVM address of the capability designer |
| commercialRevShare | number | Revenue share percentage for commercial use (0-100) |
{
"type": "object",
"required": [
"capability",
"designerAddress",
"designerName"
],
"properties": {
"ipfsCid": {
"type": "string",
"description": "IPFS CID of the capability spec document (optional)"
},
"capability": {
"type": "object",
"required": [
"id",
"name",
"type",
"kernelId"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"kernelId": {
"type": "string"
},
"description": {
"type": "string"
}
},
"description": "Capability object"
},
"designerName": {
"type": "string",
"description": "Display name of the designer"
},
"designerAddress": {
"type": "string",
"description": "EVM address of the capability designer"
},
"commercialRevShare": {
"type": "number",
"description": "Revenue share percentage for commercial use (0-100)"
}
}
}Register job evidence as a derivative IP asset on Story Protocol, linking it to the parent capability's IP. Operators earn royalties from derivative use.
| Argument | Type | Description |
|---|---|---|
| jobId* | string | Job ID whose evidence is being registered |
| ipfsCid | string | IPFS CID of the evidence bundle (optional) |
| parentIpId* | string | IP ID of the parent capability |
| operatorName* | string | Display name of the operator |
| operatorAddress* | string | EVM address of the operator |
| evidenceBundleHash* | string | Hash of the evidence bundle |
{
"type": "object",
"required": [
"parentIpId",
"jobId",
"evidenceBundleHash",
"operatorAddress",
"operatorName"
],
"properties": {
"jobId": {
"type": "string",
"description": "Job ID whose evidence is being registered"
},
"ipfsCid": {
"type": "string",
"description": "IPFS CID of the evidence bundle (optional)"
},
"parentIpId": {
"type": "string",
"description": "IP ID of the parent capability"
},
"operatorName": {
"type": "string",
"description": "Display name of the operator"
},
"operatorAddress": {
"type": "string",
"description": "EVM address of the operator"
},
"evidenceBundleHash": {
"type": "string",
"description": "Hash of the evidence bundle"
}
}
}Reject a machine registration with a reason. The operator can see the rejection reason and resubmit.
| Argument | Type | Description |
|---|---|---|
| reason | string | Reason for rejection |
| registrationId* | string | Registration ID |
{
"type": "object",
"required": [
"registrationId"
],
"properties": {
"reason": {
"type": "string",
"description": "Reason for rejection"
},
"registrationId": {
"type": "string",
"description": "Registration ID"
}
}
}Release a milestone payment on-chain after the challenge window has expired. Returns transaction hash.
| Argument | Type | Description |
|---|---|---|
| address* | string | Escrow contract address (0x...) |
| milestoneIndex* | number | Milestone index to release (0-based) |
{
"type": "object",
"required": [
"address",
"milestoneIndex"
],
"properties": {
"address": {
"type": "string",
"description": "Escrow contract address (0x...)"
},
"milestoneIndex": {
"type": "number",
"description": "Milestone index to release (0-based)"
}
}
}Compose a live PCC dashboard for a physical-capability task — pass a DashboardManifest (windows + live data bindings + actions) and it renders as an interactive MCP App.
| Argument | Type | Description |
|---|---|---|
| csd* | any | The builtin CSD URI this manifest conforms to. |
| theme | any | |
| title* | string | |
| api_base | string | Gateway base URL. Default https://capability.network. |
| sections* | array | |
| description | string |
{
"$id": "https://capability.network/ui-kit/v1/manifest.schema.json",
"type": "object",
"title": "PCC Dashboard Manifest",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"csd",
"title",
"sections"
],
"properties": {
"csd": {
"const": "pcc://artifacts/dashboard/v1",
"description": "The builtin CSD URI this manifest conforms to."
},
"theme": {
"enum": [
"auto",
"dark",
"light"
]
},
"title": {
"type": "string",
"minLength": 1
},
"api_base": {
"type": "string",
"description": "Gateway base URL. Default https://capability.network."
},
"sections": {
"type": "array",
"items": {
"$ref": "#/definitions/Section"
},
"maxItems": 24
},
"description": {
"type": "string"
}
},
"definitions": {
"Action": {
"type": "object",
"required": [
"id",
"label",
"kind",
"path",
"confirm",
"intentText"
],
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"body": {
"type": "object",
"description": "Static body merged into the request."
},
"kind": {
"enum": [
"post",
"patch"
]
},
"path": {
"type": "string",
"minLength": 1
},
"label": {
"type": "string",
"minLength": 1
},
"confirm": {
"enum": [
"inline",
"approval"
],
"description": "'inline' = button confirm; 'approval' = the kit's Approval window. NO 'none'."
},
"bodyFrom": {
"type": "string",
"description": "Form id whose collected values become the request body."
},
"arguments": {
"type": "object",
"description": "Bounded arguments for the typed operation (host mode only)."
},
"intentText": {
"type": "string",
"minLength": 1,
"description": "Snapshot-mode chip text handed to the LLM (e.g. 'pcc: approve offer …')."
},
"operation_id": {
"type": "string",
"minLength": 1,
"description": "R4 PR2 — typed host-mediated operation id. In an MCP-App host view the click routes to the registered pcc.op.<operation_id> tool via tools/call (server-authorized); the raw kind/path is inert in host mode. Standalone rendering ignores this."
},
"idempotencyFrom": {
"type": "string",
"description": "Field id supplying an idempotencyKey (required on offer-posting actions)."
}
},
"description": "A write the surface can perform. Fires ONLY on a human click; nothing on load. confirm has NO 'none'. Money verbs use confirm:'approval'.",
"additionalProperties": false
},
"Window": {
"oneOf": [
{
"type": "object",
"required": [
"kind",
"text"
],
"properties": {
"kind": {
"const": "note"
},
"text": {
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"kind",
"label",
"binding"
],
"properties": {
"kind": {
"const": "metric"
},
"label": {
"type": "string",
"minLength": 1
},
"format": {
"enum": [
"usd",
"int",
"pct",
"ts"
]
},
"select": {
"type": "string"
},
"binding": {
"$ref": "#/definitions/Binding"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"kind",
"binding"
],
"properties": {
"kind": {
"const": "capability"
},
"binding": {
"$ref": "#/definitions/Binding"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"kind",
"binding",
"item"
],
"properties": {
"item": {
"$ref": "#/definitions/ListItem"
},
"kind": {
"const": "list"
},
"limit": {
"type": "integer",
"maximum": 200,
"exclusiveMinimum": 0
},
"binding": {
"$ref": "#/definitions/Binding"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"kind",
"schema",
"submit"
],
"properties": {
"kind": {
"const": "form"
},
"schema": {
"type": "object",
"description": "A JSON Schema whose properties become form fields."
},
"submit": {
"$ref": "#/definitions/Action"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"kind",
"binding",
"statusFrom",
"latestFrom"
],
"properties": {
"kind": {
"const": "run"
},
"binding": {
"$ref": "#/definitions/Binding"
},
"latestFrom": {
"type": "string"
},
"statusFrom": {
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"kind",
"binding",
"approve"
],
"properties": {
"deny": {
"$ref": "#/definitions/Action"
},
"kind": {
"const": "approval"
},
"approve": {
"$ref": "#/definitions/Action"
},
"binding": {
"$ref": "#/definitions/Binding"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"kind",
"binding"
],
"properties": {
"kind": {
"const": "receipt"
},
"binding": {
"$ref": "#/definitions/Binding"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"kind",
"composeRef"
],
"properties": {
"kind": {
"const": "chain"
},
"execute": {
"$ref": "#/definitions/Action"
},
"composeRef": {
"$ref": "#/definitions/ComposeRequest"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"kind",
"actions"
],
"properties": {
"kind": {
"const": "actions"
},
"actions": {
"type": "array",
"items": {
"$ref": "#/definitions/Action"
},
"maxItems": 24,
"minItems": 1
}
},
"additionalProperties": false
}
]
},
"Binding": {
"type": "object",
"required": [
"path"
],
"properties": {
"sse": {
"type": "string",
"minLength": 1,
"description": "SSE stream '/sse/stream/…' (fetch-SSE with Bearer)."
},
"path": {
"type": "string",
"minLength": 1,
"description": "'/api/…' route the window reads."
},
"query": {
"type": "object",
"description": "Query params merged onto the request."
},
"pollMs": {
"type": "integer",
"minimum": 2000,
"description": "Poll cadence in ms (default ~30000; Zod floors at MIN_POLL_MS=2000 so a shared dashboard can't fast-poll authenticated endpoints)."
},
"select": {
"type": "string",
"description": "Dot-path into the response (e.g. 'data.jobs.0.status'). NOT JSONPath."
}
},
"description": "A live-data binding: which route a window reads, how often, what to pluck.",
"additionalProperties": false
},
"Section": {
"type": "object",
"required": [
"windows"
],
"properties": {
"heading": {
"type": "string"
},
"windows": {
"type": "array",
"items": {
"$ref": "#/definitions/Window"
},
"maxItems": 24
}
},
"additionalProperties": false
},
"ListItem": {
"type": "object",
"required": [
"title"
],
"properties": {
"meta": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"maxItems": 12,
"description": "Dot-path fields for the row's meta line (capped at 12 — meta selectors loop per rendered row)."
},
"title": {
"type": "string",
"minLength": 1,
"description": "Dot-path field for each row's title."
},
"statusFrom": {
"type": "string",
"description": "Dot-path field for the row's status pill."
}
},
"additionalProperties": false
},
"ComposeRequest": {
"type": "object",
"required": [
"outcomeType",
"budgetUSD",
"minAssuranceTier"
],
"properties": {
"steps": {
"type": "array",
"items": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"maxItems": 20,
"minItems": 1
},
"location": {
"type": "object",
"required": [
"lat",
"lng"
],
"properties": {
"lat": {
"type": "number",
"maximum": 90,
"minimum": -90
},
"lng": {
"type": "number",
"maximum": 180,
"minimum": -180
},
"radiusKm": {
"type": "number",
"maximum": 20000,
"exclusiveMinimum": 0
}
},
"additionalProperties": false
},
"budgetUSD": {
"type": "number",
"maximum": 1000000000,
"exclusiveMinimum": 0
},
"requester": {
"type": "object",
"required": [
"agentId"
],
"properties": {
"did": {
"type": "string",
"minLength": 1
},
"agentId": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
},
"description": {
"type": "string",
"maxLength": 4000,
"minLength": 1
},
"optimizeFor": {
"enum": [
"price",
"speed",
"quality"
]
},
"outcomeType": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"outcomeChain": {
"type": "array",
"items": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"maxItems": 20,
"minItems": 1
},
"minAssuranceTier": {
"enum": [
0,
1,
2,
3
]
}
},
"description": "A re-plannable value-chain request (mirrors @pcc/spec ComposeRequestSchema). Pinned in a chain window, never a compositionId (30-min TTL).",
"additionalProperties": false
}
},
"description": "JSON-Schema mirror of @pcc/spec DashboardManifestSchema (packages/spec/src/types/ui-artifact.ts). The small declarative dashboard a person's LLM emits; the pcc-ui kit renders it. Windows are a closed set rendered textContent-only. Actions never carry confirm:\"none\" (a human click is the confirm step). A manifest must NOT contain an API key (pcc_live_/pcc_test_) anywhere — a shared artifact travels with its contents. This mirror now carries the Zod RESOURCE CAPS (sections/windows/actions maxItems 24, list.limit max 200, meta maxItems 12, pollMs minimum 2000) so a generator validating only against this schema does not emit manifests the gateway then rejects. TWO Zod guards are not expressible as JSON-Schema validation and are enforced only by the gateway's Zod (the authoritative gate): the 256KB byte cap (MAX_MANIFEST_BYTES) and the recursive no-credential refine (containsApiKey — rejects a baked pcc key / Bearer / JWT, raw, percent-encoded, or base64). Validate against the Zod DashboardManifestSchema for the full gate.",
"additionalProperties": false
}Compose a live PCC dashboard rendered through the closed, PCC-owned IR (read-only). Pass a DashboardManifest; it renders as an interactive MCP App via the audited closed-IR render path.
| Argument | Type | Description |
|---|---|---|
| csd* | any | The builtin CSD URI this manifest conforms to. |
| theme | any | |
| title* | string | |
| api_base | string | Gateway base URL. Default https://capability.network. |
| sections* | array | |
| description | string |
{
"$id": "https://capability.network/ui-kit/v1/manifest.schema.json",
"type": "object",
"title": "PCC Dashboard Manifest",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"csd",
"title",
"sections"
],
"properties": {
"csd": {
"const": "pcc://artifacts/dashboard/v1",
"description": "The builtin CSD URI this manifest conforms to."
},
"theme": {
"enum": [
"auto",
"dark",
"light"
]
},
"title": {
"type": "string",
"minLength": 1
},
"api_base": {
"type": "string",
"description": "Gateway base URL. Default https://capability.network."
},
"sections": {
"type": "array",
"items": {
"$ref": "#/definitions/Section"
},
"maxItems": 24
},
"description": {
"type": "string"
}
},
"definitions": {
"Action": {
"type": "object",
"required": [
"id",
"label",
"kind",
"path",
"confirm",
"intentText"
],
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"body": {
"type": "object",
"description": "Static body merged into the request."
},
"kind": {
"enum": [
"post",
"patch"
]
},
"path": {
"type": "string",
"minLength": 1
},
"label": {
"type": "string",
"minLength": 1
},
"confirm": {
"enum": [
"inline",
"approval"
],
"description": "'inline' = button confirm; 'approval' = the kit's Approval window. NO 'none'."
},
"bodyFrom": {
"type": "string",
"description": "Form id whose collected values become the request body."
},
"arguments": {
"type": "object",
"description": "Bounded arguments for the typed operation (host mode only)."
},
"intentText": {
"type": "string",
"minLength": 1,
"description": "Snapshot-mode chip text handed to the LLM (e.g. 'pcc: approve offer …')."
},
"operation_id": {
"type": "string",
"minLength": 1,
"description": "R4 PR2 — typed host-mediated operation id. In an MCP-App host view the click routes to the registered pcc.op.<operation_id> tool via tools/call (server-authorized); the raw kind/path is inert in host mode. Standalone rendering ignores this."
},
"idempotencyFrom": {
"type": "string",
"description": "Field id supplying an idempotencyKey (required on offer-posting actions)."
}
},
"description": "A write the surface can perform. Fires ONLY on a human click; nothing on load. confirm has NO 'none'. Money verbs use confirm:'approval'.",
"additionalProperties": false
},
"Window": {
"oneOf": [
{
"type": "object",
"required": [
"kind",
"text"
],
"properties": {
"kind": {
"const": "note"
},
"text": {
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"kind",
"label",
"binding"
],
"properties": {
"kind": {
"const": "metric"
},
"label": {
"type": "string",
"minLength": 1
},
"format": {
"enum": [
"usd",
"int",
"pct",
"ts"
]
},
"select": {
"type": "string"
},
"binding": {
"$ref": "#/definitions/Binding"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"kind",
"binding"
],
"properties": {
"kind": {
"const": "capability"
},
"binding": {
"$ref": "#/definitions/Binding"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"kind",
"binding",
"item"
],
"properties": {
"item": {
"$ref": "#/definitions/ListItem"
},
"kind": {
"const": "list"
},
"limit": {
"type": "integer",
"maximum": 200,
"exclusiveMinimum": 0
},
"binding": {
"$ref": "#/definitions/Binding"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"kind",
"schema",
"submit"
],
"properties": {
"kind": {
"const": "form"
},
"schema": {
"type": "object",
"description": "A JSON Schema whose properties become form fields."
},
"submit": {
"$ref": "#/definitions/Action"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"kind",
"binding",
"statusFrom",
"latestFrom"
],
"properties": {
"kind": {
"const": "run"
},
"binding": {
"$ref": "#/definitions/Binding"
},
"latestFrom": {
"type": "string"
},
"statusFrom": {
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"kind",
"binding",
"approve"
],
"properties": {
"deny": {
"$ref": "#/definitions/Action"
},
"kind": {
"const": "approval"
},
"approve": {
"$ref": "#/definitions/Action"
},
"binding": {
"$ref": "#/definitions/Binding"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"kind",
"binding"
],
"properties": {
"kind": {
"const": "receipt"
},
"binding": {
"$ref": "#/definitions/Binding"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"kind",
"composeRef"
],
"properties": {
"kind": {
"const": "chain"
},
"execute": {
"$ref": "#/definitions/Action"
},
"composeRef": {
"$ref": "#/definitions/ComposeRequest"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"kind",
"actions"
],
"properties": {
"kind": {
"const": "actions"
},
"actions": {
"type": "array",
"items": {
"$ref": "#/definitions/Action"
},
"maxItems": 24,
"minItems": 1
}
},
"additionalProperties": false
}
]
},
"Binding": {
"type": "object",
"required": [
"path"
],
"properties": {
"sse": {
"type": "string",
"minLength": 1,
"description": "SSE stream '/sse/stream/…' (fetch-SSE with Bearer)."
},
"path": {
"type": "string",
"minLength": 1,
"description": "'/api/…' route the window reads."
},
"query": {
"type": "object",
"description": "Query params merged onto the request."
},
"pollMs": {
"type": "integer",
"minimum": 2000,
"description": "Poll cadence in ms (default ~30000; Zod floors at MIN_POLL_MS=2000 so a shared dashboard can't fast-poll authenticated endpoints)."
},
"select": {
"type": "string",
"description": "Dot-path into the response (e.g. 'data.jobs.0.status'). NOT JSONPath."
}
},
"description": "A live-data binding: which route a window reads, how often, what to pluck.",
"additionalProperties": false
},
"Section": {
"type": "object",
"required": [
"windows"
],
"properties": {
"heading": {
"type": "string"
},
"windows": {
"type": "array",
"items": {
"$ref": "#/definitions/Window"
},
"maxItems": 24
}
},
"additionalProperties": false
},
"ListItem": {
"type": "object",
"required": [
"title"
],
"properties": {
"meta": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"maxItems": 12,
"description": "Dot-path fields for the row's meta line (capped at 12 — meta selectors loop per rendered row)."
},
"title": {
"type": "string",
"minLength": 1,
"description": "Dot-path field for each row's title."
},
"statusFrom": {
"type": "string",
"description": "Dot-path field for the row's status pill."
}
},
"additionalProperties": false
},
"ComposeRequest": {
"type": "object",
"required": [
"outcomeType",
"budgetUSD",
"minAssuranceTier"
],
"properties": {
"steps": {
"type": "array",
"items": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"maxItems": 20,
"minItems": 1
},
"location": {
"type": "object",
"required": [
"lat",
"lng"
],
"properties": {
"lat": {
"type": "number",
"maximum": 90,
"minimum": -90
},
"lng": {
"type": "number",
"maximum": 180,
"minimum": -180
},
"radiusKm": {
"type": "number",
"maximum": 20000,
"exclusiveMinimum": 0
}
},
"additionalProperties": false
},
"budgetUSD": {
"type": "number",
"maximum": 1000000000,
"exclusiveMinimum": 0
},
"requester": {
"type": "object",
"required": [
"agentId"
],
"properties": {
"did": {
"type": "string",
"minLength": 1
},
"agentId": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
},
"description": {
"type": "string",
"maxLength": 4000,
"minLength": 1
},
"optimizeFor": {
"enum": [
"price",
"speed",
"quality"
]
},
"outcomeType": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"outcomeChain": {
"type": "array",
"items": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"maxItems": 20,
"minItems": 1
},
"minAssuranceTier": {
"enum": [
0,
1,
2,
3
]
}
},
"description": "A re-plannable value-chain request (mirrors @pcc/spec ComposeRequestSchema). Pinned in a chain window, never a compositionId (30-min TTL).",
"additionalProperties": false
}
},
"description": "JSON-Schema mirror of @pcc/spec DashboardManifestSchema (packages/spec/src/types/ui-artifact.ts). The small declarative dashboard a person's LLM emits; the pcc-ui kit renders it. Windows are a closed set rendered textContent-only. Actions never carry confirm:\"none\" (a human click is the confirm step). A manifest must NOT contain an API key (pcc_live_/pcc_test_) anywhere — a shared artifact travels with its contents. This mirror now carries the Zod RESOURCE CAPS (sections/windows/actions maxItems 24, list.limit max 200, meta maxItems 12, pollMs minimum 2000) so a generator validating only against this schema does not emit manifests the gateway then rejects. TWO Zod guards are not expressible as JSON-Schema validation and are enforced only by the gateway's Zod (the authoritative gate): the 256KB byte cap (MAX_MANIFEST_BYTES) and the recursive no-credential refine (containsApiKey — rejects a baked pcc key / Bearer / JWT, raw, percent-encoded, or base64). Validate against the Zod DashboardManifestSchema for the full gate.",
"additionalProperties": false
}Reply to an existing support thread. Use when the operator wants to add information to a thread started earlier. Needs the threadId from check_support_replies or the original send_support_message response.
| Argument | Type | Description |
|---|---|---|
| message* | string | Reply message |
| threadId* | string | Thread ID to reply to |
| retrievalCode | string | Optional diagnostic retrieval code to attach |
{
"type": "object",
"required": [
"threadId",
"message"
],
"properties": {
"message": {
"type": "string",
"description": "Reply message"
},
"threadId": {
"type": "string",
"description": "Thread ID to reply to"
},
"retrievalCode": {
"type": "string",
"description": "Optional diagnostic retrieval code to attach"
}
}
}Report a detected anomaly — protocol failure, evidence mismatch, stuck job, or suspicious behavior. All agents on the network are notified.
| Argument | Type | Description |
|---|---|---|
| jobId | string | Related job ID (optional) |
| category* | string | Anomaly category |
| severity* | string | Anomaly severity |
| description* | string | Human-readable description of what went wrong |
| targetAgentId | string | Agent or kernel ID being reported (optional) |
{
"type": "object",
"required": [
"severity",
"category",
"description"
],
"properties": {
"jobId": {
"type": "string",
"description": "Related job ID (optional)"
},
"category": {
"enum": [
"protocol_failure",
"evidence_mismatch",
"consensus_failure",
"timeout",
"rate_anomaly",
"trust_violation"
],
"type": "string",
"description": "Anomaly category"
},
"severity": {
"enum": [
"info",
"warning",
"critical"
],
"type": "string",
"description": "Anomaly severity"
},
"description": {
"type": "string",
"description": "Human-readable description of what went wrong"
},
"targetAgentId": {
"type": "string",
"description": "Agent or kernel ID being reported (optional)"
}
}
}Report a protocol failure — when a step in the evidence/escrow/verification pipeline breaks. System may auto-recover.
| Argument | Type | Description |
|---|---|---|
| jobId | string | Related job ID |
| protocol* | string | Which protocol failed: evidence_submission, escrow_release, verification_consensus, settlement |
| errorCode* | string | Error code |
| errorMessage* | string | Error description |
| involvedAgents* | array | Agent IDs involved |
| recoveryAction | string | Suggested recovery |
{
"type": "object",
"required": [
"protocol",
"errorCode",
"errorMessage",
"involvedAgents"
],
"properties": {
"jobId": {
"type": "string",
"description": "Related job ID"
},
"protocol": {
"type": "string",
"description": "Which protocol failed: evidence_submission, escrow_release, verification_consensus, settlement"
},
"errorCode": {
"type": "string",
"description": "Error code"
},
"errorMessage": {
"type": "string",
"description": "Error description"
},
"involvedAgents": {
"type": "array",
"items": {
"type": "string"
},
"description": "Agent IDs involved"
},
"recoveryAction": {
"enum": [
"retry",
"escalate",
"rollback",
"ignore"
],
"type": "string",
"description": "Suggested recovery"
}
}
}Mark an anomaly as resolved with a resolution note.
| Argument | Type | Description |
|---|---|---|
| anomalyId* | string | Anomaly ID to resolve |
| resolution* | string | How the anomaly was resolved |
{
"type": "object",
"required": [
"anomalyId",
"resolution"
],
"properties": {
"anomalyId": {
"type": "string",
"description": "Anomaly ID to resolve"
},
"resolution": {
"type": "string",
"description": "How the anomaly was resolved"
}
}
}Submit a verifier's verdict for a verification request. Returns consensus state after this vote.
| Argument | Type | Description |
|---|---|---|
| notes | string | Optional notes explaining the verdict |
| verdict* | string | Verifier's verdict |
| requestId* | string | Verification request ID (hvreq_...) |
| signature* | string | Cryptographic signature of the verdict |
| verifierId* | string | Verifier node ID |
{
"type": "object",
"required": [
"requestId",
"verifierId",
"verdict",
"signature"
],
"properties": {
"notes": {
"type": "string",
"description": "Optional notes explaining the verdict"
},
"verdict": {
"enum": [
"match",
"no_match",
"inconclusive"
],
"type": "string",
"description": "Verifier's verdict"
},
"requestId": {
"type": "string",
"description": "Verification request ID (hvreq_...)"
},
"signature": {
"type": "string",
"description": "Cryptographic signature of the verdict"
},
"verifierId": {
"type": "string",
"description": "Verifier node ID"
}
}
}Resume a paused protocol run from where it stopped.
| Argument | Type | Description |
|---|---|---|
| runId* | string | Protocol run ID to resume |
{
"type": "object",
"required": [
"runId"
],
"properties": {
"runId": {
"type": "string",
"description": "Protocol run ID to resume"
}
}
}Retrieve raw data from IPFS by CID. Used to fetch archived evidence bundles from decentralized storage.
| Argument | Type | Description |
|---|---|---|
| cid* | string | IPFS content identifier (CID) |
{
"type": "object",
"required": [
"cid"
],
"properties": {
"cid": {
"type": "string",
"description": "IPFS content identifier (CID)"
}
}
}Revoke an API key permanently. The key will immediately stop working. You must own the key. Use list_api_keys to find the key ID.
| Argument | Type | Description |
|---|---|---|
| keyId* | string | Key ID to revoke (from list_api_keys) |
{
"type": "object",
"required": [
"keyId"
],
"properties": {
"keyId": {
"type": "string",
"description": "Key ID to revoke (from list_api_keys)"
}
}
}Save a generated dashboard to the network so the user gets a live, shareable URL: https://capability.network/a/<slug>. Pass a `manifest` — a small declarative DashboardManifest (windows + live-data bindings + actions) conforming to the schema at https://capability.network/ui-kit/v1/manifest.schema.json; the shipped pcc-ui kit renders it identically everywhere (you compose the manifest, the kit renders it — never hand-rolled HTML). WHEN to call this: only when the task needs a surface to watch/approve/compare/reuse (a live job, a value chain, a settlement trail, a recurring order) — never for a one-line answer. RECALL FIRST: call search_dashboards before generating; reload or fork a match instead of duplicating. The manifest MUST NOT contain an API key (a shared artifact travels with its contents — the network rejects one that does). Returns the stored artifact incl. its slug. Defaults visibility to 'unlisted' (link-shareable, not listed).
| Argument | Type | Description |
|---|---|---|
| name* | string | Short human name for the dashboard, e.g. 'Watch my pizza + courier'. Used to mint the slug. |
| manifest* | object | The DashboardManifest (2-6KB JSON) conforming to https://capability.network/ui-kit/v1/manifest.schema.json. Required top-level keys: `csd` (must be 'pcc://artifacts/dashboard/v1'), `title`, and `sections[]` (each section has `windows[]`). Window kinds: note, metric, capability, list, form, run, approval, receipt, chain, actions. Bindings point at live routes you already use (/api/jobs/:id, /api/escrow/:id, /sse/stream/job/:id). No API key anywhere in the manifest. |
| visibility | string | Who can load it. Default 'unlisted' (anyone with the link; not in listings). 'public' appears in search_dashboards; 'private' is owner-only. |
| composeRefs |
Search capability templates by type or keyword. Returns templates with pricing, assurance tiers, and availability.
| Argument | Type | Description |
|---|---|---|
| query* | string | Search query (type name, material, process, etc.) |
{
"type": "object",
"required": [
"query"
],
"properties": {
"query": {
"type": "string",
"description": "Search query (type name, material, process, etc.)"
}
}
}Discover existing public dashboards before you generate a new one (recall-first — the library accrues; adopt > extend > build for UIs too). Filter by `capabilityType` (e.g. 'pizza.order'), free-text `q` over name/description/types, and `sort` by popularity or recency. Returns { entries, total, offset, limit }. Only public artifacts are listed; unlisted ones load by slug via get_dashboard but never appear here.
| Argument | Type | Description |
|---|---|---|
| q | string | Free-text search over name, description, and capability types. |
| sort | string | Ranking: 'popular' (by use+load+fork counts) or 'recent' (default). |
| limit | integer | Max results (1..100, default 20). |
| offset | integer | Pagination offset (default 0). |
| capabilityType | string | Filter to dashboards tagged with this capability type, e.g. 'pizza.order'. |
{
"type": "object",
"required": [],
"properties": {
"q": {
"type": "string",
"description": "Free-text search over name, description, and capability types."
},
"sort": {
"enum": [
"popular",
"recent"
],
"type": "string",
"description": "Ranking: 'popular' (by use+load+fork counts) or 'recent' (default)."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Max results (1..100, default 20)."
},
"offset": {
"type": "integer",
"minimum": 0,
"description": "Pagination offset (default 0)."
},
"capabilityType": {
"type": "string",
"description": "Filter to dashboards tagged with this capability type, e.g. 'pizza.order'."
}
}
}Search for lab/workshop hosting spaces. Filter by size, access schedule, and other requirements.
| Argument | Type | Description |
|---|---|---|
| access | string | Access schedule (24/7, business-hours, all) |
| maxSqft | number | Maximum square footage |
{
"type": "object",
"required": [],
"properties": {
"access": {
"type": "string",
"description": "Access schedule (24/7, business-hours, all)"
},
"maxSqft": {
"type": "number",
"description": "Maximum square footage"
}
}
}Upload an encrypted diagnostic bundle when the operator's node has problems. The bundle is encrypted client-side with a retrieval code the operator must share with support before logs can be read. Use this when the operator reports errors, crashes, or misbehavior. The pcc-node CLI runs `pcc-node logs --send` locally to collect+encrypt; prefer that path when available. This tool is for agent-driven uploads when the bundle is already prepared.
| Argument | Type | Description |
|---|---|---|
| kernelId* | string | Kernel ID the diagnostics came from |
| encrypted* | object | Encrypted bundle payload |
| bundleHash | string | sha256 of plaintext bundle |
| bundleSize | number | Size of encrypted payload in bytes |
| collectedAt | string | ISO timestamp when bundle was collected |
| logLineCount | number | How many log lines are in the bundle |
| systemPlatform | string | e.g. Linux-5.15, Darwin-23, Windows-10 |
{
"type": "object",
"required": [
"kernelId",
"encrypted"
],
"properties": {
"kernelId": {
"type": "string",
"description": "Kernel ID the diagnostics came from"
},
"encrypted": {
"type": "object",
"required": [
"ciphertext_b64",
"iv_b64",
"salt_b64",
"tag_b64"
],
"properties": {
"iv_b64": {
"type": "string"
},
"tag_b64": {
"type": "string"
},
"salt_b64": {
"type": "string"
},
"ciphertext_b64": {
"type": "string"
}
},
"description": "Encrypted bundle payload"
},
"bundleHash": {
"type": "string",
"description": "sha256 of plaintext bundle"
},
"bundleSize": {
"type": "number",
"description": "Size of encrypted payload in bytes"
},
"collectedAt": {
"type": "string",
"description": "ISO timestamp when bundle was collected"
},
"logLineCount": {
"type": "number",
"description": "How many log lines are in the bundle"
},
"systemPlatform": {
"type": "string",
"description": "e.g. Linux-5.15, Darwin-23, Windows-10"
}
}
}Send an operator support message to the PCC team. Creates a new support thread or appends to the operator's existing open thread. Can optionally attach a diagnostic retrieval code (from send_diagnostics) so support staff can decrypt logs. Discord webhook fires on every new message, so expect fast response. Use this whenever the operator says something is broken, confusing, or not behaving as expected.
| Argument | Type | Description |
|---|---|---|
| message* | string | The support message text — describe the problem concretely |
| subject | string | Optional thread subject (auto-generated from message if omitted) |
| kernelId* | string | Operator's kernel ID |
| kernelName | string | Human-readable kernel name |
| systemInfo | object | Optional system context (platform, nodeVersion, daemonRunning, gatewayReachable) |
| retrievalCode | string | Optional diagnostic retrieval code to attach (from send_diagnostics) |
{
"type": "object",
"required": [
"kernelId",
"message"
],
"properties": {
"message": {
"type": "string",
"description": "The support message text — describe the problem concretely"
},
"subject": {
"type": "string",
"description": "Optional thread subject (auto-generated from message if omitted)"
},
"kernelId": {
"type": "string",
"description": "Operator's kernel ID"
},
"kernelName": {
"type": "string",
"description": "Human-readable kernel name"
},
"systemInfo": {
"type": "object",
"description": "Optional system context (platform, nodeVersion, daemonRunning, gatewayReachable)"
},
"retrievalCode": {
"type": "string",
"description": "Optional diagnostic retrieval code to attach (from send_diagnostics)"
}
}
}Auto-detect current setup state: env vars, database, adapters, chain connectivity, storage, identity. Use this to see what's configured and what's missing before onboarding.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}Generate a KERNEL_CONFIG JSON from device descriptions. Tell it what machines you have and it produces the config ready to paste into your environment.
| Argument | Type | Description |
|---|---|---|
| devices* | array | Array of device descriptions with type, model, and connection info |
{
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of device descriptions with type, model, and connection info"
}
}
}Register a device in the database with adapter config and capabilities. Part of Step 3 in the onboarding flow. Required: kernelId, deviceId, type and adapterType (400 missing_required_fields otherwise).
| Argument | Type | Description |
|---|---|---|
| type* | string | Device role: machine, sensor or camera (the values setup_generate_config and setup_validate accept) |
| model | string | Device model identifier (optional; stored as "unknown" if absent) |
| deviceId* | string | Your ID for this device, unique within the kernel |
| kernelId* | string | Kernel ID to register the device under |
| adapterType* | string | One of octoprint, modbus, opcua, sila, ipp, generic-http or mock; the route refuses anything else (including opentrons) |
| capabilities | array | Capability types this device serves |
| adapterConfig | object | Adapter-specific configuration (host, port, auth, etc.) |
{
"type": "object",
"required": [
"kernelId",
"deviceId",
"type",
"adapterType"
],
"properties": {
"type": {
"type": "string",
"description": "Device role: machine, sensor or camera (the values setup_generate_config and setup_validate accept)"
},
"model": {
"type": "string",
"description": "Device model identifier (optional; stored as \"unknown\" if absent)"
},
"deviceId": {
"type": "string",
"description": "Your ID for this device, unique within the kernel"
},
"kernelId": {
"type": "string",
"description": "Kernel ID to register the device under"
},
"adapterType": {
"type": "string",
"description": "One of octoprint, modbus, opcua, sila, ipp, generic-http or mock; the route refuses anything else (including opentrons)"
},
"capabilities": {
"type": "array",
"items": {
"type": "string"
},
"description": "Capability types this device serves"
},
"adapterConfig": {
"type": "object",
"description": "Adapter-specific configuration (host, port, auth, etc.)"
}
}
}Comprehensive setup status across 6 categories: gateway, database, adapters, chain, storage, identity. Use to confirm everything is green before going live.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}Submit a test job to verify the full pipeline works end-to-end (Step 4 of onboarding). Returns job ID and result.
| Argument | Type | Description |
|---|---|---|
| deviceId | string | Specific device ID to test (optional) |
| kernelId* | string | Kernel ID to test |
{
"type": "object",
"required": [
"kernelId"
],
"properties": {
"deviceId": {
"type": "string",
"description": "Specific device ID to test (optional)"
},
"kernelId": {
"type": "string",
"description": "Kernel ID to test"
}
}
}Validate a kernel config (20+ checks: JSON structure, device connectivity, adapter compatibility). Returns validation errors and warnings.
| Argument | Type | Description |
|---|---|---|
| config* | object | Kernel config JSON to validate |
{
"type": "object",
"required": [
"config"
],
"properties": {
"config": {
"type": "object",
"description": "Kernel config JSON to validate"
}
}
}Stake USDC or credits into a capability investment pool.
| Argument | Type | Description |
|---|---|---|
| amount* | number | Amount to stake |
| poolId* | string | Investment pool ID |
| staker* | string | Address or DID of the staker |
{
"type": "object",
"required": [
"poolId",
"staker",
"amount"
],
"properties": {
"amount": {
"type": "number",
"description": "Amount to stake"
},
"poolId": {
"type": "string",
"description": "Investment pool ID"
},
"staker": {
"type": "string",
"description": "Address or DID of the staker"
}
}
}Start execution of a protocol run that is in 'ready' or 'binding' state.
| Argument | Type | Description |
|---|---|---|
| runId* | string | Protocol run ID to start |
{
"type": "object",
"required": [
"runId"
],
"properties": {
"runId": {
"type": "string",
"description": "Protocol run ID to start"
}
}
}Submit a verifier attestation for a milestone on-chain. Used by third-party verifiers (Bittensor subnet) to confirm evidence quality. Returns transaction hash.
| Argument | Type | Description |
|---|---|---|
| address* | string | Escrow contract address (0x...) |
| milestoneIndex* | number | Milestone index (0-based) |
| attestationHash* | string | Attestation hash as 0x-prefixed hex bytes32 |
{
"type": "object",
"required": [
"address",
"milestoneIndex",
"attestationHash"
],
"properties": {
"address": {
"type": "string",
"description": "Escrow contract address (0x...)"
},
"milestoneIndex": {
"type": "number",
"description": "Milestone index (0-based)"
},
"attestationHash": {
"type": "string",
"description": "Attestation hash as 0x-prefixed hex bytes32"
}
}
}Signal that you want a capability that doesn't exist on the network yet. Creates a demand signal and may auto-create a bounty if enough demand accumulates.
| Argument | Type | Description |
|---|---|---|
| description* | string | Description of what you need |
| requesterId* | string | ID of the requester |
| assuranceTier | number | Required assurance tier (0-3) |
| capabilityType* | string | Type of capability wanted (e.g. electron-beam-welding, cryo-em) |
| estimatedJobValue | number | Estimated payment per job in USD |
| estimatedFrequency | string | How often you would use this capability |
{
"type": "object",
"required": [
"requesterId",
"capabilityType",
"description"
],
"properties": {
"description": {
"type": "string",
"description": "Description of what you need"
},
"requesterId": {
"type": "string",
"description": "ID of the requester"
},
"assuranceTier": {
"type": "number",
"description": "Required assurance tier (0-3)"
},
"capabilityType": {
"type": "string",
"description": "Type of capability wanted (e.g. electron-beam-welding, cryo-em)"
},
"estimatedJobValue": {
"type": "number",
"description": "Estimated payment per job in USD"
},
"estimatedFrequency": {
"enum": [
"one-time",
"weekly",
"monthly",
"daily"
],
"type": "string",
"description": "How often you would use this capability"
}
}
}Submit an evidence bundle hash for a milestone on-chain. Links the physical evidence to the on-chain settlement record. Returns transaction hash.
| Argument | Type | Description |
|---|---|---|
| address* | string | Escrow contract address (0x...) |
| milestoneIndex* | number | Milestone index (0-based) |
| evidenceBundleHash* | string | Evidence bundle hash as 0x-prefixed hex bytes32 |
{
"type": "object",
"required": [
"address",
"milestoneIndex",
"evidenceBundleHash"
],
"properties": {
"address": {
"type": "string",
"description": "Escrow contract address (0x...)"
},
"milestoneIndex": {
"type": "number",
"description": "Milestone index (0-based)"
},
"evidenceBundleHash": {
"type": "string",
"description": "Evidence bundle hash as 0x-prefixed hex bytes32"
}
}
}Submit a bug report, suggestion, or general feedback about the PCC network.
| Argument | Type | Description |
|---|---|---|
| page | string | Page or feature the feedback relates to |
| type | string | Feedback type |
| message* | string | Feedback message (max 5000 chars) |
{
"type": "object",
"required": [
"message"
],
"properties": {
"page": {
"type": "string",
"description": "Page or feature the feedback relates to"
},
"type": {
"enum": [
"bug",
"comment",
"difficulty",
"suggestion"
],
"type": "string",
"description": "Feedback type"
},
"message": {
"type": "string",
"description": "Feedback message (max 5000 chars)"
}
}
}Submit an evidence bundle for human verification. Selects a panel of verifiers from the network and returns assigned verifier IDs.
| Argument | Type | Description |
|---|---|---|
| photoRef* | string | Reference to the photo evidence (CID or URL) |
| bundleHash* | string | SHA-256 hash of the evidence bundle |
| referenceRef* | string | Reference to the reference/spec document |
| verifierCount | number | Number of verifiers to assign (default 5) |
| comparisonScore | number | Pre-computed comparison score 0-1 (optional) |
{
"type": "object",
"required": [
"bundleHash",
"photoRef",
"referenceRef"
],
"properties": {
"photoRef": {
"type": "string",
"description": "Reference to the photo evidence (CID or URL)"
},
"bundleHash": {
"type": "string",
"description": "SHA-256 hash of the evidence bundle"
},
"referenceRef": {
"type": "string",
"description": "Reference to the reference/spec document"
},
"verifierCount": {
"type": "number",
"description": "Number of verifiers to assign (default 5)"
},
"comparisonScore": {
"type": "number",
"description": "Pre-computed comparison score 0-1 (optional)"
}
}
}Bidirectional onboarding: the registry talks back. Describe in plain English what you are trying to set up — 'wood-fired pizza shop in SF', 'Opentrons OT-2 liquid handler', 'same-day SF courier' — and the registry returns N candidate Capability StructureDefinition (CSD) templates ranked by keyword-overlap relevance (name×3, tags×2, description×1; tie-break on usage). Empty query falls back to popularity-ordered top picks. After picking one, pass the chosen type to pcc-author-integration. Score-zero results are dropped.
| Argument | Type | Description |
|---|---|---|
| q | string | Plain-English description of the capability the user is trying to set up. Optional — empty falls back to popularity. |
| kind | string | Filter by CSD kind. |
| limit | integer | Max results (1..20, default 5). |
{
"type": "object",
"required": [],
"properties": {
"q": {
"type": "string",
"description": "Plain-English description of the capability the user is trying to set up. Optional — empty falls back to popularity."
},
"kind": {
"enum": [
"base",
"profile",
"extension",
"workflow"
],
"type": "string",
"description": "Filter by CSD kind."
},
"limit": {
"type": "integer",
"maximum": 20,
"minimum": 1,
"description": "Max results (1..20, default 5)."
}
}
}Raw system state dump — actual DB rows for kernels, devices, jobs, evidence, registrations, capabilities, agent conversations, audit log. No fake numbers, no summaries.
No arguments.
{
"type": "object",
"properties": {}
}Fire a synthetic job at every enabled channel for an operator so the onboarding agent (and the human watching) can confirm the integration end-to-end before a real job lands. Returns per-channel dispatch results (delivered, ref, warnings).
| Argument | Type | Description |
|---|---|---|
| slug* | string | Operator slug. |
{
"type": "object",
"required": [
"slug"
],
"properties": {
"slug": {
"type": "string",
"description": "Operator slug."
}
}
}Modify a dashboard you own (owner-only). Replace the manifest or any metadata field; the version increments. Use this to edit a saved surface meaningfully — 'raise budgetUSD to 40', 'add a receipt window', 'make it public'. A replaced manifest must still conform to the schema and must not contain an API key. Only send the fields you want to change.
| Argument | Type | Description |
|---|---|---|
| id* | string | The id (ua_...) of the artifact to update. |
| name | string | New name. |
| manifest | object | Replacement DashboardManifest (must conform to the schema; no API key). Omit to leave the manifest unchanged. |
| visibility | string | New visibility (e.g. flip 'unlisted' -> 'public' to list it). |
| composeRefs | array | Replacement pinned ComposeRequest objects. |
| description | string | New description. |
| renderedCid | string | New rendered-HTML export CID. |
| capabilityTypes | array | Replacement capability-type tags. |
Update a job's status and optional progress percentage. Used by kernels to report job progress.
| Argument | Type | Description |
|---|---|---|
| jobId* | string | Job ID |
| status* | string | New status (pending, queued, in_progress, paused, completed, failed, cancelled). 'running' is accepted as a legacy alias for in_progress. |
| progress | number | Progress percentage 0-100 (optional) |
{
"type": "object",
"required": [
"jobId",
"status"
],
"properties": {
"jobId": {
"type": "string",
"description": "Job ID"
},
"status": {
"type": "string",
"description": "New status (pending, queued, in_progress, paused, completed, failed, cancelled). 'running' is accepted as a legacy alias for in_progress."
},
"progress": {
"type": "number",
"description": "Progress percentage 0-100 (optional)"
}
}
}Update an existing channel — toggle enabled, rewrite the describe contract, change the endpoint payload, etc. Merges into the existing record. The operator slug, id, and createdAt are immutable.
| Argument | Type | Description |
|---|---|---|
| id* | string | Channel id (returned from attach_operator_channel). |
| label | string | |
| enabled | boolean | |
| describe | string | |
| endpoint | object | |
| direction | string | |
| credentialRef | string | |
| replyContract | string |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Channel id (returned from attach_operator_channel)."
},
"label": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"describe": {
"type": "string"
},
"endpoint": {
"type": "object"
},
"direction": {
"enum": [
"out",
"in-out",
"in"
],
"type": "string"
},
"credentialRef": {
"type": "string"
},
"replyContract": {
"type": "string"
}
}
}Update an existing protocol template (must be in draft status). Returns updated name and version.
| Argument | Type | Description |
|---|---|---|
| id* | string | Protocol template ID |
| name | string | Updated name |
| steps | array | Updated steps array |
| version | string | New version string (semver) |
| parameters | array | Updated parameters array |
| description | string | Updated description |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Protocol template ID"
},
"name": {
"type": "string",
"description": "Updated name"
},
"steps": {
"type": "array",
"description": "Updated steps array"
},
"version": {
"type": "string",
"description": "New version string (semver)"
},
"parameters": {
"type": "array",
"description": "Updated parameters array"
},
"description": {
"type": "string",
"description": "Updated description"
}
}
}Validate a protocol template against a specific kernel — checks capability availability, transfer compatibility, and automation level feasibility.
| Argument | Type | Description |
|---|---|---|
| id* | string | Protocol template ID |
| kernelId | string | Kernel ID to validate against (optional) |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Protocol template ID"
},
"kernelId": {
"type": "string",
"description": "Kernel ID to validate against (optional)"
}
}
}Verify bounty completion by scoring the delivered capability against requirements.
| Argument | Type | Description |
|---|---|---|
| jobId* | string | Job ID that fulfilled the bounty |
| score* | number | Verification score (0-1) |
| bountyId* | string | Bounty ID to verify |
{
"type": "object",
"required": [
"bountyId",
"jobId",
"score"
],
"properties": {
"jobId": {
"type": "string",
"description": "Job ID that fulfilled the bounty"
},
"score": {
"type": "number",
"description": "Verification score (0-1)"
},
"bountyId": {
"type": "string",
"description": "Bounty ID to verify"
}
}
}Verify a ZK proof by its proof ID. Checks the proof against its verification key and public inputs.
| Argument | Type | Description |
|---|---|---|
| proofId* | string | ID of the ZK proof to verify |
{
"type": "object",
"required": [
"proofId"
],
"properties": {
"proofId": {
"type": "string",
"description": "ID of the ZK proof to verify"
}
}
}| transport* | string | Which wire does the message go over. `manual` = no machine endpoint (dashboard-only). |
| credentialRef | string | Reference to a secret in the credential vault (not the secret itself). PCC resolves it at dispatch time. |
| replyContract | string | Optional operator-authored contract describing how the operator's system will respond to evidence requests, status pings, etc. |
{
"type": "object",
"required": [
"slug",
"label",
"transport",
"describe"
],
"properties": {
"slug": {
"type": "string",
"description": "Operator slug (typically the operator's address or unique identifier)."
},
"label": {
"type": "string",
"description": "Short human label shown to the operator and in admin UIs: 'Front counter printer', 'Owner's phone'."
},
"enabled": {
"type": "boolean",
"description": "Whether the channel is live (defaults to true)."
},
"describe": {
"type": "string",
"description": "Plain-English instructions for how PCC should talk to whatever is on the other end. Written by the operator's onboarding agent. Required, ≥4 chars. Example: 'POST JSON with keys order_id, line_items[], deadline_iso. I will POST back {order_id, status} to your reply URL.'"
},
"endpoint": {
"type": "object",
"description": "Transport-specific routing payload. webhook→{url}, email→{address}, sms/voice→{phoneE164}, push→{token,platform}, mqtt→{brokerUrl,topic}, file→{scheme,path}, manual→{}."
},
"direction": {
"enum": [
"out",
"in-out",
"in"
],
"type": "string",
"description": "out=PCC pushes only; in-out=operator's system also replies; in=operator pushes unsolicited."
},
"transport": {
"enum": [
"webhook",
"email",
"sms",
"voice",
"push",
"mqtt",
"file",
"manual"
],
"type": "string",
"description": "Which wire does the message go over. `manual` = no machine endpoint (dashboard-only)."
},
"credentialRef": {
"type": "string",
"description": "Reference to a secret in the credential vault (not the secret itself). PCC resolves it at dispatch time."
},
"replyContract": {
"type": "string",
"description": "Optional operator-authored contract describing how the operator's system will respond to evidence requests, status pings, etc."
}
}
}| string |
| Detailed product description |
| leadTimeDays | number | Estimated lead time in business days |
| pricePerUnit* | number | Price per unit in USDC |
{
"type": "object",
"required": [
"category",
"name",
"pricePerUnit",
"unit"
],
"properties": {
"name": {
"type": "string",
"description": "Product name"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Search tags"
},
"unit": {
"type": "string",
"description": "Unit of sale: kg, L, each, box, plate, etc."
},
"inStock": {
"type": "boolean",
"description": "Whether the item is currently available"
},
"category": {
"type": "string",
"description": "Category: raw-metals, plastics-polymers, lab-reagents, lab-consumables, electronics, chemicals, biologicals, tooling, packaging, calibration, safety, other"
},
"location": {
"type": "string",
"description": "Supplier region or country"
},
"maxOrder": {
"type": "number",
"description": "Maximum order quantity"
},
"minOrder": {
"type": "number",
"description": "Minimum order quantity"
},
"sellerId": {
"type": "string",
"description": "Supplier entity ID"
},
"description": {
"type": "string",
"description": "Detailed product description"
},
"leadTimeDays": {
"type": "number",
"description": "Estimated lead time in business days"
},
"pricePerUnit": {
"type": "number",
"description": "Price per unit in USDC"
}
}
}| captureBytesBase64* | string | Base64-encoded capture bytes (image / video / audio / sensor clip). Hash must match manifest.mediaHash. |
{
"type": "object",
"required": [
"manifest",
"captureBytesBase64"
],
"properties": {
"jobId": {
"type": "string",
"description": "Job ID for telemetry binding. Falls back to manifest.jobId if omitted."
},
"manifest": {
"type": "object",
"description": "CaptureManifest — ALCOA+-ready metadata: class, declaredAt (ISO-8601), deviceFingerprint, mediaHash (sha256:<hex>), optional challengeId. See CaptureManifestSchema in @pcc/spec."
},
"operatorId": {
"type": "string",
"description": "Explicit operator ID. Falls back to the authenticated session userId."
},
"challengeId": {
"type": "string",
"description": "Challenge UUID to re-bind to the in-memory challenge cache (G3 freshness gate)."
},
"submittedAt": {
"type": "integer",
"description": "Client-submitted timestamp (epoch ms). Used in drift detection."
},
"visualNonceEcho": {
"type": "string",
"description": "The visual nonce value the operator rendered in-scene (QR payload, audio tone id, etc.)."
},
"c2paManifestBase64": {
"type": "string",
"description": "Optional base64-encoded C2PA manifest JUMBF bytes. Required when manifest.class >= CC3."
},
"captureBytesBase64": {
"type": "string",
"description": "Base64-encoded capture bytes (image / video / audio / sensor clip). Hash must match manifest.mediaHash."
}
}
}| allowedPipettes |
| array |
| Which pipettes may be used (e.g. ['left']) |
{
"type": "object",
"required": [
"kernelId",
"allowedTools"
],
"properties": {
"jobId": {
"type": "string",
"description": "Job ID this scope is bound to (optional)"
},
"kernelId": {
"type": "string",
"description": "Kernel ID to create the scope for"
},
"maxRetries": {
"type": "number",
"description": "Maximum retries allowed (default 3)"
},
"ttlMinutes": {
"type": "number",
"description": "Scope duration in minutes (default 30)"
},
"maxCommands": {
"type": "number",
"description": "Maximum tool calls allowed in this scope (default 100)"
},
"allowedSlots": {
"type": "array",
"items": {
"type": "number"
},
"description": "Which deck slots may be accessed (e.g. [1, 2, 3, 9])"
},
"allowedTools": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of tool names allowed in this scope (e.g. ['ot2_protocol_upload', 'ot2_run_create', 'ot2_run_action'])"
},
"protocolHash": {
"type": "string",
"description": "SHA-256 hash of the approved protocol content. If set, protocol uploads are hash-verified."
},
"allowedPipettes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Which pipettes may be used (e.g. ['left'])"
}
}
}| string |
| 1-line description of what you were doing and what went wrong. Example: 'POST /api/build/contract returned 500 with no hint about the missing field.' |
| traceId | string | Your journey ID — returned by provision_api_key and on every response as `x-pcc-trace-id` (also in a 5xx `report_hint.traceId`). Lets PCC replay your full run. |
| endpoint | string | The route you were on when you got stuck. From a 5xx `report_hint.send.endpoint`. Example: '/api/build/contract'. |
| severity | string | How badly this blocked you. Optional. |
| errorCode | string | The machine error code from the response body, if any. From `report_hint.send.errorCode`. |
{
"type": "object",
"required": [
"summary"
],
"properties": {
"logs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"note": {
"type": "string",
"maxLength": 500,
"description": "One line on what happened at this step."
},
"path": {
"type": "string",
"description": "Route, e.g. /api/build/price."
},
"step": {
"type": "integer",
"description": "1-based step index."
},
"method": {
"type": "string",
"description": "HTTP method, e.g. POST."
},
"status": {
"type": "integer",
"description": "HTTP status you got."
}
}
},
"maxItems": 20,
"description": "Optional but valuable: your last few steps as SUMMARIES (never full request/response bodies) — the sequence that led to the failure. Secrets are never allowed in a note."
},
"type": {
"enum": [
"bug",
"friction",
"idea"
],
"type": "string",
"description": "bug = something is broken/wrong; friction = it works but was confusing/harder than it should be; idea = a suggestion or missing capability. Defaults to bug."
},
"detail": {
"type": "string",
"maxLength": 20000,
"description": "Multi-line context: the full error body, what you tried, what you expected. Optional but recommended."
},
"method": {
"type": "string",
"description": "The HTTP method you used. From `report_hint.send.method`. Example: 'POST'."
},
"status": {
"type": "integer",
"description": "The HTTP status you got. From `report_hint.send.status`. Example: 500."
},
"agentId": {
"type": "string",
"description": "Which model/agent you are. Example: 'claude', 'gpt-4o', 'gemini'. Optional."
},
"summary": {
"type": "string",
"maxLength": 5000,
"minLength": 4,
"description": "1-line description of what you were doing and what went wrong. Example: 'POST /api/build/contract returned 500 with no hint about the missing field.'"
},
"traceId": {
"type": "string",
"description": "Your journey ID — returned by provision_api_key and on every response as `x-pcc-trace-id` (also in a 5xx `report_hint.traceId`). Lets PCC replay your full run."
},
"endpoint": {
"type": "string",
"description": "The route you were on when you got stuck. From a 5xx `report_hint.send.endpoint`. Example: '/api/build/contract'."
},
"severity": {
"enum": [
"low",
"medium",
"high",
"critical"
],
"type": "string",
"description": "How badly this blocked you. Optional."
},
"errorCode": {
"type": "string",
"description": "The machine error code from the response body, if any. From `report_hint.send.errorCode`."
}
}
}| phase* | any |
| detail | string | null |
| device | object | null |
| phases | array | null | Only on phase "session": the roll-up |
| tokens | object | null | Never guess: send null with source "unknown" |
| consent | object | null |
| harness | object | null |
| outcome* | any |
| summary | string | null | One line, e.g. "register: failed, POST /api/kernels 400" |
| traceId | string | null | x-pcc-trace-id of the last PCC call |
| contract | integer |
| proposal | object | null | One improvement idea |
| sessionId* | string | UUID v4, generated once at the start of the attempt |
| durationMs | integer | null | The phase's wall time; on session, the whole attempt |
{
"if": {
"properties": {
"phase": {
"not": {
"const": "session"
}
}
}
},
"then": {
"not": {
"required": [
"phases"
]
}
},
"type": "object",
"required": [
"kind",
"sessionId",
"seq",
"phase",
"outcome"
],
"properties": {
"env": {
"type": [
"object",
"null"
],
"properties": {
"os": {
"type": [
"string",
"null"
],
"maxLength": 64
},
"python": {
"type": [
"string",
"null"
],
"maxLength": 64
},
"pccNode": {
"type": [
"string",
"null"
],
"maxLength": 64
}
},
"additionalProperties": false
},
"ids": {
"type": [
"object",
"null"
],
"properties": {
"jobId": {
"type": [
"string",
"null"
],
"pattern": "^[A-Za-z0-9:._/-]+$",
"maxLength": 200
},
"kitId": {
"type": [
"string",
"null"
],
"pattern": "^[A-Za-z0-9:._/-]+$",
"maxLength": 200
},
"kernelId": {
"type": [
"string",
"null"
],
"pattern": "^[A-Za-z0-9:._/-]+$",
"maxLength": 200
},
"capabilityId": {
"type": [
"string",
"null"
],
"pattern": "^[A-Za-z0-9:._/-]+$",
"maxLength": 200
}
},
"description": "Only the ids known so far: each at most 200 characters of [A-Za-z0-9:._/-], or null",
"additionalProperties": false
},
"seq": {
"type": "integer",
"maximum": 10000,
"minimum": 0,
"description": "Per-session report counter"
},
"kind": {
"enum": [
"attempt"
],
"type": "string"
},
"logs": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"note": {
"type": [
"string",
"null"
]
},
"path": {
"type": [
"string",
"null"
]
},
"step": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"method": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"integer",
"null"
]
}
},
"additionalProperties": false
},
"maxItems": 20,
"description": "The phase's step timeline, summaries only"
},
"pack": {
"type": [
"object",
"null"
],
"properties": {
"digest": {
"type": [
"string",
"null"
],
"pattern": "^sha256:[0-9a-f]{64}$",
"description": "sha256:<64 hex> of this package's bytes"
},
"version": {
"type": [
"string",
"null"
],
"maxLength": 64
}
},
"additionalProperties": false
},
"phase": {
"anyOf": [
{
"enum": [
"prerequisites",
"identify",
"intake",
"research",
"build",
"register",
"verify",
"operate",
"publish",
"session"
],
"type": "string"
},
{
"type": "string",
"minLength": 1,
"description": "Any other value: the server stores \"other\", with the raw value (clamped to 64 characters) as phaseLabel."
}
]
},
"detail": {
"type": [
"string",
"null"
],
"maxLength": 20000
},
"device": {
"type": [
"object",
"null"
],
"properties": {
"make": {
"type": [
"string",
"null"
],
"maxLength": 128
},
"class": {
"enum": [
"lab_instrument",
"robot",
"printer",
"process_agent",
"other",
null
],
"type": [
"string",
"null"
]
},
"model": {
"type": [
"string",
"null"
],
"maxLength": 128
}
},
"additionalProperties": false
},
"phases": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"required": [
"phase",
"outcome"
],
"properties": {
"phase": {
"anyOf": [
{
"enum": [
"prerequisites",
"identify",
"intake",
"research",
"build",
"register",
"verify",
"operate",
"publish",
"session"
],
"type": "string"
},
{
"type": "string",
"minLength": 1,
"description": "Any other value: the server stores \"other\", with the raw value (clamped to 64 characters) as phaseLabel."
},
{
"type": "null"
}
]
},
"outcome": {
"anyOf": [
{
"enum": [
"ok",
"failed",
"blocked",
"skipped",
"budget_stop",
"abandoned",
"in_progress",
"budget-stop"
],
"type": "string"
},
{
"type": "string",
"minLength": 1,
"description": "Any other value: the server stores \"unknown\", with the raw value as outcomeLabel."
},
{
"type": "null"
}
]
},
"durationMs": {
"type": [
"integer",
"null"
],
"maximum": 86400000,
"minimum": 0
}
},
"additionalProperties": false
},
"maxItems": 16,
"description": "Only on phase \"session\": the roll-up"
},
"tokens": {
"type": [
"object",
"null"
],
"properties": {
"in": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"out": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"source": {
"enum": [
"self_reported",
"harness",
"metered",
"unknown",
null
],
"type": [
"string",
"null"
]
}
},
"description": "Never guess: send null with source \"unknown\"",
"additionalProperties": false
},
"consent": {
"type": [
"object",
"null"
],
"properties": {
"transcript": {
"enum": [
false
],
"type": "boolean"
}
},
"additionalProperties": false
},
"harness": {
"type": [
"object",
"null"
],
"properties": {
"name": {
"anyOf": [
{
"enum": [
"claude-code",
"codex",
"pcc-hosted",
"other"
],
"type": "string"
},
{
"type": "string",
"minLength": 1,
"description": "Any other name: the server stores \"other\", with the raw name as label."
},
{
"type": "null"
}
]
},
"label": {
"type": [
"string",
"null"
],
"maxLength": 128
},
"model": {
"type": [
"string",
"null"
],
"maxLength": 128
},
"version": {
"type": [
"string",
"null"
],
"maxLength": 128
}
},
"additionalProperties": false
},
"outcome": {
"anyOf": [
{
"enum": [
"ok",
"failed",
"blocked",
"skipped",
"budget_stop",
"abandoned",
"in_progress",
"budget-stop"
],
"type": "string"
},
{
"type": "string",
"minLength": 1,
"description": "Any other value: the server stores \"unknown\", with the raw value as outcomeLabel."
}
]
},
"summary": {
"type": [
"string",
"null"
],
"maxLength": 5000,
"description": "One line, e.g. \"register: failed, POST /api/kernels 400\""
},
"traceId": {
"type": [
"string",
"null"
],
"maxLength": 200,
"description": "x-pcc-trace-id of the last PCC call"
},
"contract": {
"enum": [
1
],
"type": "integer"
},
"proposal": {
"type": [
"object",
"null"
],
"properties": {
"path": {
"type": [
"string",
"null"
],
"pattern": "^[^?]*$",
"maxLength": 2000,
"description": "No query string"
},
"text": {
"type": [
"string",
"null"
],
"maxLength": 5000
},
"target": {
"enum": [
"runbook",
"agent-package",
"docs",
"code",
"process",
"other",
null
],
"type": [
"string",
"null"
]
}
},
"description": "One improvement idea",
"additionalProperties": false
},
"sessionId": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"description": "UUID v4, generated once at the start of the attempt"
},
"durationMs": {
"type": [
"integer",
"null"
],
"maximum": 86400000,
"minimum": 0,
"description": "The phase's wall time; on session, the whole attempt"
}
},
"additionalProperties": false
}{
"type": "object",
"required": [
"title",
"description"
],
"properties": {
"title": {
"type": "string",
"description": "Short title for the request"
},
"budget": {
"type": "number",
"description": "Total budget in USDC (default: 1000)"
},
"urgency": {
"enum": [
"standard",
"rush",
"emergency"
],
"type": "string",
"description": "Urgency level — affects cost multipliers (emergency: 2x cost, 0.5x time)"
},
"currency": {
"type": "string",
"description": "Currency (default: USDC)"
},
"deadline": {
"type": "string",
"description": "ISO 8601 deadline (default: 7 days from now)"
},
"description": {
"type": "string",
"description": "Full natural language description of what needs to be built or done"
},
"requesterEmail": {
"type": "string",
"description": "Requester email for notifications"
},
"requesterWallet": {
"type": "string",
"description": "Requester wallet address for payments"
}
}
}| string |
| Fleet-controller account username (basic-auth mode only) |
| pollIntervalMs | number | Poll interval in ms for run status (range 500-60000). Default: 3000. |
| tcodeApiVersion | string | Pinned tcode-api version on the fleet controller. Format: 'latest' or semver (e.g. 1.25.1). Default: latest. Surfaces in evidence bundles for reproducibility. |
| mockRunDurationMs | number | Mock-mode simulated run duration in ms. Default: 2000. |
| maxScriptTimeoutSec | number | Maximum allowed wall-clock seconds for a single tcode script (range 30-86400). Default: 3600. |
| allowArbitraryScripts | boolean | Permit customer-supplied tcode-api Python scripts (true) or only curated protocol IDs (false). Default: false. Set true only for trusted-counterparty deployments. |
{
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Fleet-controller URL on the LAN (host[:port], no trailing slash, no path) — e.g. http://192.168.1.50"
},
"apiKey": {
"type": "string",
"description": "Trilobio fleet-controller API key (from the trilobot admin UI). Either apiKey OR username+password is required unless mockMode=true."
},
"deviceId": {
"type": "string",
"description": "Logical device ID within the kernel (default: trilobio-fleet-01)"
},
"kernelId": {
"type": "string",
"description": "Kernel ID this device belongs to (auto-generated as kernel_trilobio_<timestamp> if omitted)"
},
"mockMode": {
"type": "boolean",
"description": "Bypass real HTTP and simulate runs. Use for CI / floor demos. Default: false."
},
"password": {
"type": "string",
"description": "Fleet-controller account password (basic-auth mode only)"
},
"username": {
"type": "string",
"description": "Fleet-controller account username (basic-auth mode only)"
},
"pollIntervalMs": {
"type": "number",
"description": "Poll interval in ms for run status (range 500-60000). Default: 3000."
},
"tcodeApiVersion": {
"type": "string",
"description": "Pinned tcode-api version on the fleet controller. Format: 'latest' or semver (e.g. 1.25.1). Default: latest. Surfaces in evidence bundles for reproducibility."
},
"mockRunDurationMs": {
"type": "number",
"description": "Mock-mode simulated run duration in ms. Default: 2000."
},
"maxScriptTimeoutSec": {
"type": "number",
"description": "Maximum allowed wall-clock seconds for a single tcode script (range 30-86400). Default: 3600."
},
"allowArbitraryScripts": {
"type": "boolean",
"description": "Permit customer-supplied tcode-api Python scripts (true) or only curated protocol IDs (false). Default: false. Set true only for trusted-counterparty deployments."
}
}
}| mockRunDurationMs |
| number |
| maxScriptTimeoutSec | number |
| allowArbitraryScripts | boolean |
{
"type": "object",
"required": [],
"properties": {
"url": {
"type": "string",
"description": "Fleet-controller URL"
},
"apiKey": {
"type": "string",
"description": "Fleet-controller API key"
},
"deviceId": {
"type": "string"
},
"kernelId": {
"type": "string"
},
"mockMode": {
"type": "boolean"
},
"password": {
"type": "string",
"description": "Basic-auth password"
},
"username": {
"type": "string",
"description": "Basic-auth username"
},
"pollIntervalMs": {
"type": "number"
},
"tcodeApiVersion": {
"type": "string",
"description": "'latest' or semver string"
},
"mockRunDurationMs": {
"type": "number"
},
"maxScriptTimeoutSec": {
"type": "number"
},
"allowArbitraryScripts": {
"type": "boolean"
}
}
}| Alternative to `steps`: chain of named sub-outcomes. The planner expands each into capability types. |
| minAssuranceTier* | integer | Minimum acceptable assurance tier on every step. |
{
"type": "object",
"required": [
"outcomeType",
"budgetUSD",
"minAssuranceTier"
],
"properties": {
"steps": {
"type": "array",
"items": {
"type": "string"
},
"description": "Ordered list of capability types this composition needs (1..20). Use this OR `outcomeChain`."
},
"location": {
"type": "object",
"description": "Geographic constraint (lat/lng + radius, or country, etc)."
},
"budgetUSD": {
"type": "number",
"description": "Total budget the user is willing to spend across all steps."
},
"requester": {
"type": "object",
"description": "{agentId, did?} — the agent submitting the request."
},
"description": {
"type": "string",
"description": "Free-form natural-language description (≤4000 chars)."
},
"optimizeFor": {
"enum": [
"price",
"speed",
"quality"
],
"type": "string",
"description": "Ranking objective (default `price`)."
},
"outcomeType": {
"type": "string",
"description": "High-level outcome label, ≤120 chars. Example: 'desk-robot-prototype'."
},
"outcomeChain": {
"type": "array",
"items": {
"type": "string"
},
"description": "Alternative to `steps`: chain of named sub-outcomes. The planner expands each into capability types."
},
"minAssuranceTier": {
"enum": [
0,
1,
2,
3
],
"type": "integer",
"description": "Minimum acceptable assurance tier on every step."
}
}
}| array |
| Optional pinned, re-plannable ComposeRequest objects (value chains). Pin the request, never a compositionId (those expire in 30 min). |
| description | string | One-line description of what the dashboard shows. |
| renderedCid | string | Optional CID of a rendered-HTML export saved via /api/storage. |
| capabilityTypes | array | Capability types this dashboard is about, e.g. ['pizza.order','courier.dispatch']. This is the discovery join — it's how search_dashboards finds this artifact later. |
{
"type": "object",
"required": [
"name",
"manifest"
],
"properties": {
"name": {
"type": "string",
"description": "Short human name for the dashboard, e.g. 'Watch my pizza + courier'. Used to mint the slug."
},
"manifest": {
"type": "object",
"description": "The DashboardManifest (2-6KB JSON) conforming to https://capability.network/ui-kit/v1/manifest.schema.json. Required top-level keys: `csd` (must be 'pcc://artifacts/dashboard/v1'), `title`, and `sections[]` (each section has `windows[]`). Window kinds: note, metric, capability, list, form, run, approval, receipt, chain, actions. Bindings point at live routes you already use (/api/jobs/:id, /api/escrow/:id, /sse/stream/job/:id). No API key anywhere in the manifest."
},
"visibility": {
"enum": [
"private",
"unlisted",
"public"
],
"type": "string",
"description": "Who can load it. Default 'unlisted' (anyone with the link; not in listings). 'public' appears in search_dashboards; 'private' is owner-only."
},
"composeRefs": {
"type": "array",
"items": {
"type": "object"
},
"description": "Optional pinned, re-plannable ComposeRequest objects (value chains). Pin the request, never a compositionId (those expire in 30 min)."
},
"description": {
"type": "string",
"description": "One-line description of what the dashboard shows."
},
"renderedCid": {
"type": "string",
"description": "Optional CID of a rendered-HTML export saved via /api/storage."
},
"capabilityTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Capability types this dashboard is about, e.g. ['pizza.order','courier.dispatch']. This is the discovery join — it's how search_dashboards finds this artifact later."
}
}
}{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The id (ua_...) of the artifact to update."
},
"name": {
"type": "string",
"description": "New name."
},
"manifest": {
"type": "object",
"description": "Replacement DashboardManifest (must conform to the schema; no API key). Omit to leave the manifest unchanged."
},
"visibility": {
"enum": [
"private",
"unlisted",
"public"
],
"type": "string",
"description": "New visibility (e.g. flip 'unlisted' -> 'public' to list it)."
},
"composeRefs": {
"type": "array",
"items": {
"type": "object"
},
"description": "Replacement pinned ComposeRequest objects."
},
"description": {
"type": "string",
"description": "New description."
},
"renderedCid": {
"type": "string",
"description": "New rendered-HTML export CID."
},
"capabilityTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Replacement capability-type tags."
}
}
}