Request and response schemas

Accepted

Used by: completeTask, reportProgress

{
  "accepted": false
}

AccessAdmission

Preview (`evaluate`) or charge (`admit`) an operation for the authenticated caller. `target` is `label.capability`; `input` is the invocation payload the constraints are matched against. Workers pass their lease to act as the leased effective principal.

Used by: admitAccess, evaluateAccess

{
  "input": {},
  "lease_token": "string",
  "operation": "string",
  "step_id": "string",
  "target": "string",
  "task_id": "string"
}

AccessConnector

A connector binding. `revoked_at` is set once and never cleared: a revoked connector never becomes an unrestricted bearer principal again.

Used by: getConnector, getOwnConnector, putConnector, revokeConnector

{
  "enabled": false,
  "expires_at": 0,
  "grants": [
    "string"
  ],
  "principal": "string",
  "revision": 0,
  "revoked_at": 0,
  "updated_at": 0
}

AccessConnectorList

Used by: listConnectors

{
  "items": [
    {
      "enabled": false,
      "expires_at": 0,
      "grants": [
        "string"
      ],
      "principal": "string",
      "revision": 0,
      "revoked_at": 0,
      "updated_at": 0
    }
  ]
}

AccessConnectorPut

Bind an authenticated principal to an allow-list of operation patterns. Create with `expected_revision` absent or 0; replace with the current revision.

Used by: putConnector

{
  "enabled": false,
  "expected_revision": 0,
  "expires_at": 0,
  "grants": [
    "string"
  ]
}

AccessConnectorRevoke

Used by: revokeConnector

{
  "expected_revision": 0
}

AccessConstraint

One predicate over a top-level input field. Ordered operators (`<`, `<=`, `>`, `>=`) require a numeric `value`; `==` and `!=` compare JSON values.

{
  "operator": "string",
  "value": {}
}

AccessDecision

A decision is data, not an error: `allowed:false` is returned with 200.

Used by: admitAccess, evaluateAccess

{
  "allowed": false,
  "budget_ids": [
    "string"
  ],
  "policy_ids": [
    "string"
  ],
  "reason": "bearer_authorization",
  "retry_after_ms": 0,
  "warnings": [
    {
      "action": "string",
      "as_of": 0,
      "budget_id": "string",
      "consumed": 0.0,
      "enabled": false,
      "exceeded": false,
      "limit": 0.0,
      "metric": "tokens",
      "name": "string",
      "remaining": 0.0,
      "scope": "string",
      "subject": "string",
      "window": "string",
      "window_start": 0
    }
  ]
}

AccessDecisionReason

Why an admission decision was taken. `bearer_authorization` means no policy matched and the caller's existing roles decide; the other reasons name the rule that decided.

String enum: "bearer_authorization" "policy_allowed" "policy_denied" "constraint_denied" "connector_forbidden" "rate_limited" "budget_exceeded"

"bearer_authorization"

AccessEffect

Policy effect. `rate` is only valid on `allow` policies.

String enum: "allow" "deny"

"allow"

AccessPolicy

A stored policy. `expires_at` and `rate` are null when unset.

Used by: createAccessPolicy, getAccessPolicy, updateAccessPolicy

{
  "capability": "string",
  "constraints": {
    "key": {
      "operator": "string",
      "value": {}
    }
  },
  "created_at": 0,
  "effect": "allow",
  "enabled": false,
  "expires_at": 0,
  "id": "string",
  "label": "string",
  "name": "string",
  "owner": "string",
  "principal": "string",
  "rate": {
    "burst": 0,
    "requests_per_second": 0.0
  },
  "revision": 0,
  "tags": [
    "string"
  ],
  "updated_at": 0
}

AccessPolicyCreate

Used by: createAccessPolicy

{
  "capability": "string",
  "constraints": {
    "key": {
      "operator": "string",
      "value": {}
    }
  },
  "effect": "allow",
  "enabled": false,
  "expires_at": 0,
  "label": "string",
  "name": "string",
  "principal": "string",
  "rate": {
    "burst": 0,
    "requests_per_second": 0.0
  },
  "tags": [
    "string"
  ]
}

AccessPolicyDeleted

Used by: deleteAccessPolicy

{
  "deleted": false,
  "id": "string"
}

AccessPolicyList

Used by: listAccessPolicies

{
  "items": [
    {
      "capability": "string",
      "constraints": {
        "key": {
          "operator": "string",
          "value": {}
        }
      },
      "created_at": 0,
      "effect": "allow",
      "enabled": false,
      "expires_at": 0,
      "id": "string",
      "label": "string",
      "name": "string",
      "owner": "string",
      "principal": "string",
      "rate": {
        "burst": 0,
        "requests_per_second": 0.0
      },
      "revision": 0,
      "tags": [
        "string"
      ],
      "updated_at": 0
    }
  ]
}

AccessPolicyUpdate

Compare-and-set edit. `label` is immutable; unknown keys are rejected.

Used by: updateAccessPolicy

{
  "capability": "string",
  "constraints": {
    "key": {
      "operator": "string",
      "value": {}
    }
  },
  "effect": "allow",
  "enabled": false,
  "expected_revision": 0,
  "expires_at": 0,
  "name": "string",
  "principal": "string",
  "rate": {
    "burst": 0,
    "requests_per_second": 0.0
  },
  "tags": [
    "string"
  ]
}

AccessRate

Token bucket shared by every capability the policy matches, per principal.

{
  "burst": 0,
  "requests_per_second": 0.0
}

Admission

Used by: fireEmitter, restartTraverser, submitTraverser

{
  "id": "string",
  "root_id": "string",
  "status": "queued",
  "step_id": "string"
}

AgentDefinition

Used by: agentCapabilities, registerAgent

{
  "capabilities": {
    "key": {
      "input_schema": {},
      "kind": "traversal",
      "output_schema": {},
      "realtime": {
        "model": "string",
        "provider": "string",
        "transport": "string"
      },
      "retry": {
        "max_attempts": 0
      },
      "tags": [
        "string"
      ],
      "timeout_seconds": 0
    }
  },
  "id": "string",
  "label": "string",
  "tags": [
    "string"
  ],
  "version": "string"
}

AgentList

Used by: listAgents

{
  "items": [
    {
      "capabilities": {
        "key": {
          "input_schema": {},
          "kind": {},
          "output_schema": {},
          "realtime": {},
          "retry": {},
          "tags": [
            {}
          ],
          "timeout_seconds": 0
        }
      },
      "id": "string",
      "label": "string",
      "tags": [
        "string"
      ],
      "version": "string"
    }
  ]
}

AgentRemoved

Result of `DELETE /api/v2/agents/{label}`: every version of the label is gone from the namespace.

Used by: unregisterAgent

{
  "deleted": false,
  "label": "string",
  "versions": 0
}

ApiError

{
  "code": "string",
  "message": "string"
}

ApiToken

A stored token without its secret: only the first 8 characters (`prefix`) are ever shown again. `active` is false once revoked or expired; a `revoked_at` in the future is a scheduled revocation from a rotation grace period.

Used by: revokeApiToken

{
  "active": false,
  "created_at": 0,
  "created_by": "string",
  "expires_at": 0,
  "id": "string",
  "label": "string",
  "last_used_at": 0,
  "prefix": "string",
  "principal": "string",
  "revoked_at": 0,
  "roles": [
    "string"
  ],
  "rotated_from": "string"
}

ApiTokenCreate

Issue a bearer credential for a principal of the caller's namespace.

Used by: createApiToken

{
  "expires_at": 0,
  "label": "string",
  "namespace": "string",
  "principal": "string",
  "roles": [
    "string"
  ]
}

ApiTokenCreated

The answer to create and rotate: the record plus the plaintext `token`, returned exactly once. Store it; it cannot be recovered, only rotated.

Used by: createApiToken, rotateApiToken

{
  "active": false,
  "created_at": 0,
  "created_by": "string",
  "expires_at": 0,
  "id": "string",
  "label": "string",
  "last_used_at": 0,
  "prefix": "string",
  "previous_revoked_at": 0,
  "principal": "string",
  "revoked_at": 0,
  "roles": [
    "string"
  ],
  "rotated_from": "string",
  "token": "string"
}

ApiTokenList

Used by: listApiTokens

{
  "items": [
    {
      "active": false,
      "created_at": 0,
      "created_by": "string",
      "expires_at": 0,
      "id": "string",
      "label": "string",
      "last_used_at": 0,
      "prefix": "string",
      "principal": "string",
      "revoked_at": 0,
      "roles": [
        "string"
      ],
      "rotated_from": "string"
    }
  ]
}

ApiTokenRotate

Rotate: issue a fresh secret for the same principal, roles, label and expiry and revoke the old one `grace_seconds` from now (default 0: immediately).

Used by: rotateApiToken

{
  "grace_seconds": 0
}

Approval

Used by: decideApproval, getApproval, requestApproval

{
  "checkpoint": {},
  "decided_by": "string",
  "expires_at": 0,
  "id": "string",
  "operation_key": "string",
  "paused": false,
  "prompt": {},
  "response": {},
  "status": "string",
  "traverser_id": "string"
}

ApprovalDecision

Used by: decideApproval

{
  "decision": "string",
  "response": {}
}

ApprovalList

Used by: listApprovals

{
  "items": [
    {
      "checkpoint": {},
      "decided_by": "string",
      "expires_at": 0,
      "id": "string",
      "operation_key": "string",
      "paused": false,
      "prompt": {},
      "response": {},
      "status": "string",
      "traverser_id": "string"
    }
  ]
}

ApprovalRequest

Used by: requestApproval

{
  "checkpoint": {},
  "expires_in_seconds": 0,
  "id": "string",
  "lease_token": "string",
  "operation_key": "string",
  "pause": false,
  "prompt": {},
  "worker_id": "string"
}

Artifact

Used by: putArtifact

{
  "content_type": "string",
  "created_at": 0,
  "id": "string",
  "name": "string",
  "sha256": "string",
  "size_bytes": 0,
  "traverser_id": "string"
}

ArtifactContent

Used by: getArtifact

{
  "content_type": "string",
  "created_at": 0,
  "data_base64": "string",
  "id": "string",
  "name": "string",
  "sha256": "string",
  "size_bytes": 0,
  "traverser_id": "string"
}

ArtifactDeleted

Used by: deleteArtifact

{
  "deleted": false,
  "id": "string"
}

ArtifactList

Used by: listArtifacts

{
  "items": [
    {
      "content_type": "string",
      "created_at": 0,
      "id": "string",
      "name": "string",
      "sha256": "string",
      "size_bytes": 0,
      "traverser_id": "string"
    }
  ]
}

Attempt

{
  "attempt": 0,
  "error": {},
  "finished_at": 0,
  "lease_expires_at": 0,
  "started_at": 0,
  "status": "string",
  "worker_id": "string"
}

BindSession

Used by: bindSession

{
  "id": "string",
  "lease_token": "string",
  "session_id": "string",
  "worker_id": "string"
}

BriefArtifact

One file attached to a session before any run exists (the Studio brief). Uploaded as raw bytes to `POST /api/v2/sessions/{id}/artifacts`; downloaded as raw bytes from `GET /api/v2/sessions/{id}/artifacts/{artifact_id}`.

Used by: getBriefArtifact

{
  "content_type": "string",
  "created_at": 0,
  "id": "string",
  "kind": "string",
  "name": "string",
  "session_id": "string",
  "sha256": "string",
  "size_bytes": 0
}

BriefArtifactCreated

Used by: putBriefArtifact

{
  "artifact": {
    "content_type": "string",
    "created_at": 0,
    "id": "string",
    "kind": "string",
    "name": "string",
    "session_id": "string",
    "sha256": "string",
    "size_bytes": 0
  }
}

BriefArtifactDeleted

Used by: deleteBriefArtifact

{
  "deleted": false,
  "id": "string"
}

BriefArtifactList

Used by: listBriefArtifacts

{
  "items": [
    {
      "content_type": "string",
      "created_at": 0,
      "id": "string",
      "kind": "string",
      "name": "string",
      "session_id": "string",
      "sha256": "string",
      "size_bytes": 0
    }
  ],
  "total_bytes": 0
}

Budget

Used by: createBudget, getBudget, updateBudget

{
  "action": "string",
  "created_at": 0,
  "enabled": false,
  "id": "string",
  "limit": 0.0,
  "metric": "tokens",
  "name": "string",
  "principal": "string",
  "revision": 0,
  "scope": "string",
  "subject": "string",
  "updated_at": 0,
  "window": "string"
}

BudgetCreate

Create a budget. `subject` names what the scope binds: a principal, an agent label, a `label.capability`, or nothing for `namespace`. `limit` is a positive integer for `tokens` and `runs`, a positive number for `cost_usd`.

Used by: createBudget

{
  "action": "string",
  "enabled": false,
  "limit": 0.0,
  "metric": "tokens",
  "name": "string",
  "scope": "string",
  "subject": "string",
  "window": "string"
}

BudgetList

Used by: listBudgets

{
  "items": [
    {
      "action": "string",
      "created_at": 0,
      "enabled": false,
      "id": "string",
      "limit": 0.0,
      "metric": "tokens",
      "name": "string",
      "principal": "string",
      "revision": 0,
      "scope": "string",
      "subject": "string",
      "updated_at": 0,
      "window": "string"
    }
  ]
}

BudgetMetric

What a budget measures: model tokens or priced cost from usage receipts, or the number of root executions admitted.

String enum: "tokens" "cost_usd" "runs"

"tokens"

BudgetStatus

Every enabled budget that applies to an admission by `principal` of `target`, with its headroom. `allowed` is false when a `deny` budget is exceeded.

Used by: budgetStatus

{
  "allowed": false,
  "items": [
    {
      "action": "string",
      "as_of": 0,
      "budget_id": "string",
      "consumed": 0.0,
      "enabled": false,
      "exceeded": false,
      "limit": 0.0,
      "metric": "tokens",
      "name": "string",
      "remaining": 0.0,
      "scope": "string",
      "subject": "string",
      "window": "string",
      "window_start": 0
    }
  ],
  "principal": "string",
  "target": "string"
}

BudgetUpdate

Compare-and-set edit. Scope, subject and metric are immutable; create a new budget to change them.

Used by: updateBudget

{
  "action": "string",
  "enabled": false,
  "expected_revision": 0,
  "limit": 0.0,
  "name": "string",
  "window": "string"
}

BudgetUsage

Consumption of one budget in its current window. `exceeded` is `consumed >= limit`; `remaining` never goes below 0.

Used by: budgetUsage

{
  "action": "string",
  "as_of": 0,
  "budget_id": "string",
  "consumed": 0.0,
  "enabled": false,
  "exceeded": false,
  "limit": 0.0,
  "metric": "tokens",
  "name": "string",
  "remaining": 0.0,
  "scope": "string",
  "subject": "string",
  "window": "string",
  "window_start": 0
}

Capability

{
  "input_schema": {},
  "kind": "traversal",
  "output_schema": {},
  "realtime": {
    "model": "string",
    "provider": "string",
    "transport": "string"
  },
  "retry": {
    "max_attempts": 0
  },
  "tags": [
    "string"
  ],
  "timeout_seconds": 0
}

CapabilityKind

`realtime` is a live-session entrypoint: listed and publishable (as `http` only), never admitted as a traverser (400 `realtime_entrypoint`).

String enum: "traversal" "skill" "decision" "realtime"

"traversal"

Checkpoint

Used by: getCheckpoint

{
  "name": "string",
  "revision": 0,
  "updated_at": 0,
  "value": {}
}

CheckpointList

Used by: listCheckpoints

{
  "items": [
    {
      "name": "string",
      "revision": 0,
      "updated_at": 0,
      "value": {}
    }
  ]
}

CheckpointRevision

Used by: writeCheckpoint

{
  "name": "string",
  "revision": 0
}

CheckpointWrite

Used by: writeCheckpoint

{
  "expected_revision": 0,
  "lease_token": "string",
  "value": {},
  "worker_id": "string"
}

Claim

Used by: claimTask

{
  "capacity": 0,
  "draining": false,
  "task": {
    "attempt": 0,
    "capability": "string",
    "deadline_at": 0,
    "emitter": {
      "emitter_id": "string",
      "event_id": "string",
      "event_type": "string",
      "idempotency_key": "string",
      "managed_by": "string",
      "received_at": "string",
      "source": "string"
    },
    "id": "string",
    "input": {},
    "kind": "string",
    "label": "string",
    "lease_expires_at": 0,
    "lease_token": "string",
    "max_attempts": 0,
    "namespace": "string",
    "parent_id": "string",
    "parent_step_id": "string",
    "principal": "string",
    "root_id": "string",
    "session_id": "string",
    "step_id": "string",
    "target": "string",
    "timeout_seconds": 0,
    "version": "string"
  }
}

CompleteTask

Used by: completeTask

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": false
  },
  "id": "string",
  "lease_token": "string",
  "output": {},
  "worker_id": "string"
}

CreateSession

Used by: createSession

{
  "id": "string"
}

Credential

Used by: getCredential, issueCredential, revokeCredential

{
  "credential": {
    "@context": [
      "string"
    ],
    "credentialSubject": {},
    "expirationDate": "string",
    "id": "string",
    "issuanceDate": "string",
    "issuer": "string",
    "proof": {
      "created": "string",
      "cryptosuite": "string",
      "proofPurpose": "string",
      "proofValue": "string",
      "type": "string",
      "verificationMethod": "string"
    },
    "type": [
      "string"
    ]
  },
  "expires_at": 0,
  "id": "string",
  "issued_at": 0,
  "issuer_did": "string",
  "issuer_key_id": "string",
  "issuer_label": "string",
  "kind": "execution",
  "node_label": "string",
  "parent_id": "string",
  "principal": "string",
  "revocation_reason": "string",
  "revoked_at": 0,
  "revoked_by": "string",
  "root_id": "string",
  "subject_id": "string",
  "traverser_id": "string",
  "type": "string"
}

CredentialIssue

Issue a credential signed by the issuer node's enrolled DID. `execution` needs `traverser_id` (terminal, owned or inside the worker's leased subtree) and is idempotent per issuer key; `custom` needs `subject` with a string `id`.

Used by: issueCredential

{
  "expires_in_seconds": 0,
  "issuer_label": "string",
  "kind": "execution",
  "lease_token": "string",
  "parent_id": "string",
  "step_id": "string",
  "subject": {
    "key": {}
  },
  "task_id": "string",
  "traverser_id": "string",
  "type": "string"
}

CredentialKind

`execution` certifies a terminal traverser, `custom` carries a caller subject, `tag` is issued only by tag decisions.

String enum: "execution" "custom" "tag"

"execution"

CredentialList

Used by: listCredentials

{
  "items": [
    {
      "credential": {
        "@context": [
          "string"
        ],
        "credentialSubject": {},
        "expirationDate": "string",
        "id": "string",
        "issuanceDate": "string",
        "issuer": "string",
        "proof": {
          "created": {},
          "cryptosuite": {},
          "proofPurpose": {},
          "proofValue": {},
          "type": {},
          "verificationMethod": {}
        },
        "type": [
          "string"
        ]
      },
      "expires_at": 0,
      "id": "string",
      "issued_at": 0,
      "issuer_did": "string",
      "issuer_key_id": "string",
      "issuer_label": "string",
      "kind": "execution",
      "node_label": "string",
      "parent_id": "string",
      "principal": "string",
      "revocation_reason": "string",
      "revoked_at": 0,
      "revoked_by": "string",
      "root_id": "string",
      "subject_id": "string",
      "traverser_id": "string",
      "type": "string"
    }
  ]
}

CredentialRevoke

Used by: revokeCredential

{
  "reason": "string"
}

CredentialVerification

`valid` is the cryptographic and temporal result; `trusted` additionally requires the credential to be known, unrevoked and issued by an enrolled, unrevoked key in this namespace. `reason` is the first failing check.

Used by: verifyCredential

{
  "checks": [
    {
      "detail": "string",
      "name": "string",
      "ok": false
    }
  ],
  "credential_id": "string",
  "evaluated_at": 0,
  "issuer": "string",
  "issuer_resolution": "string",
  "key_state": "string",
  "known": false,
  "message": "string",
  "reason": "string",
  "revoked_at": 0,
  "subject_id": "string",
  "trusted": false,
  "valid": false,
  "verification_method": "string"
}

CredentialVerify

Verify a presented credential (any issuer). `at` evaluates validity at another time; `resolve_remote` allows bounded `did:web` resolution of the issuer.

Used by: verifyCredential

{
  "at": 0,
  "credential": {},
  "lease_token": "string",
  "resolve_remote": false,
  "step_id": "string",
  "task_id": "string"
}

DataIntegrityProof

Data Integrity proof, cryptosuite `eddsa-jcs-2022`.

{
  "created": "string",
  "cryptosuite": "string",
  "proofPurpose": "string",
  "proofValue": "string",
  "type": "string",
  "verificationMethod": "string"
}

Deleted

Used by: deleteBudget, deleteEmitter, deleteEvalCase, deleteEvalCaseSet, deleteMemory, deleteMemoryVector, deleteObservabilityWebhook, deletePublication

{
  "deleted": false
}

DidDocument

W3C DID document for an enrolled Ed25519 identity.

{
  "@context": [
    "string"
  ],
  "alsoKnownAs": [
    "string"
  ],
  "assertionMethod": [
    "string"
  ],
  "authentication": [
    "string"
  ],
  "id": "string",
  "verificationMethod": [
    {
      "controller": "string",
      "id": "string",
      "publicKeyJwk": {
        "crv": "string",
        "kty": "string",
        "x": "string"
      },
      "publicKeyMultibase": "string",
      "type": "string"
    }
  ]
}

DidEnrol

Enrol the node's active identity key (created when missing) as a `did:key`.

Used by: enrolDid

{
  "label": "string"
}

DidEnrolment

An enrolled DID. `key_state` mirrors the underlying identity (`active`, `retired`, `revoked`); `also_known_as` is present when `web_base_url` was given.

Used by: enrolDid, getDid

{
  "algorithm": "string",
  "also_known_as": [
    "string"
  ],
  "created_at": 0,
  "did": "string",
  "did_document": {
    "@context": [
      "string"
    ],
    "alsoKnownAs": [
      "string"
    ],
    "assertionMethod": [
      "string"
    ],
    "authentication": [
      "string"
    ],
    "id": "string",
    "verificationMethod": [
      {
        "controller": "string",
        "id": "string",
        "publicKeyJwk": {},
        "publicKeyMultibase": "string",
        "type": "string"
      }
    ]
  },
  "encryption": "string",
  "key_id": "string",
  "key_state": "string",
  "label": "string",
  "master_key_id": "string",
  "public_key": "string",
  "public_key_multibase": "string",
  "verification_method": "string"
}

DidEnrolmentList

Used by: listDids

{
  "items": [
    {
      "algorithm": "string",
      "also_known_as": [
        "string"
      ],
      "created_at": 0,
      "did": "string",
      "did_document": {
        "@context": [
          "string"
        ],
        "alsoKnownAs": [
          "string"
        ],
        "assertionMethod": [
          "string"
        ],
        "authentication": [
          "string"
        ],
        "id": "string",
        "verificationMethod": [
          {}
        ]
      },
      "encryption": "string",
      "key_id": "string",
      "key_state": "string",
      "label": "string",
      "master_key_id": "string",
      "public_key": "string",
      "public_key_multibase": "string",
      "verification_method": "string"
    }
  ]
}

DidLocalKey

The enrolled identity behind a resolved DID, when it belongs to this namespace.

{
  "key_id": "string",
  "key_state": "string",
  "label": "string"
}

DidMethod

String enum: "key" "web"

"key"

DidResolution

`did:key` resolves offline; `did:web` is fetched over bounded HTTPS. `document` is the DID document as published by its controller.

Used by: resolveDid

{
  "canonical_did": "string",
  "did": "string",
  "document": {},
  "legacy_encoding": false,
  "local": {
    "key_id": "string",
    "key_state": "string",
    "label": "string"
  },
  "method": "key",
  "resolved_from": "string",
  "verification_methods": [
    {
      "id": "string",
      "public_key": "string",
      "type": "string"
    }
  ]
}

DidResolve

Used by: resolveDid

{
  "did": "string"
}

DiscoveryProtocols

{
  "a2a_enabled": false,
  "mcp_enabled": false,
  "public_base_url": "string"
}

DiscoveryPublication

Used by: publishDiscovery

{
  "artifact": {},
  "artifact_type": "string",
  "description": "string",
  "display_name": "string",
  "id": "string",
  "label": "string",
  "published": false,
  "tags": [
    "string"
  ],
  "updated_at": 0,
  "validation": {
    "scope": "string",
    "status": "string"
  },
  "version": "string"
}

DiscoveryPublications

Used by: listPublications, searchDiscovery

{
  "items": [
    {
      "artifact": {},
      "artifact_type": "string",
      "description": "string",
      "display_name": "string",
      "id": "string",
      "label": "string",
      "published": false,
      "tags": [
        "string"
      ],
      "updated_at": 0,
      "validation": {
        "scope": "string",
        "status": "string"
      },
      "version": "string"
    }
  ]
}

DiscoverySearch

Used by: searchDiscovery

{
  "query": "string",
  "tags": [
    "string"
  ]
}

DiscoverySettings

Used by: discoverySettings

{
  "configuration_path": "string",
  "configuration_source": "string",
  "enabled": false,
  "locked_reason": "string",
  "protocols": {
    "a2a_enabled": false,
    "mcp_enabled": false,
    "public_base_url": "string"
  },
  "public_base_url": "string",
  "public_registry": false,
  "publish_catalog": false
}

DiscoveryValidation

{
  "scope": "string",
  "status": "string"
}

Draining

Used by: drainWorker

{
  "draining": false
}

Emitter

Used by: createEmitter, getEmitter, updateEmitter

{
  "code_origin": "string",
  "cron_expression": "string",
  "enabled": false,
  "event_types": [
    "string"
  ],
  "id": "string",
  "input": {},
  "interval_seconds": 0,
  "kind": "string",
  "last_registered_at": 0,
  "managed_by": "string",
  "name": "string",
  "next_due_at": 0,
  "orphaned": false,
  "revision": 0,
  "secret_env": "string",
  "source": "string",
  "source_config": {
    "actions": [
      "set"
    ],
    "auth_mode": "string",
    "basic_username": "string",
    "event_id_path": "string",
    "event_type_header": "string",
    "event_type_path": "string",
    "header": "string",
    "idempotency_header": "string",
    "job_ids": [
      {}
    ],
    "kinds": [
      "value"
    ],
    "prefix": "string",
    "scheme": "string",
    "scope": "session",
    "scope_id": "string",
    "signature_header": "string",
    "signature_prefix": "string",
    "timestamp_header": "string",
    "tolerance_seconds": 0,
    "workspace_id": "string",
    "workspace_path": "string"
  },
  "sticky_paused": false,
  "target": "string",
  "timezone": "string",
  "version": "string"
}

EmitterBinding

{
  "capability": "string",
  "code_origin": "string",
  "cron_expression": "string",
  "event_types": [
    "string"
  ],
  "input": {},
  "interval_seconds": 0,
  "secret_env": "string",
  "source": "string",
  "source_config": {
    "actions": [
      "set"
    ],
    "auth_mode": "string",
    "basic_username": "string",
    "event_id_path": "string",
    "event_type_header": "string",
    "event_type_path": "string",
    "header": "string",
    "idempotency_header": "string",
    "job_ids": [
      {}
    ],
    "kinds": [
      "value"
    ],
    "prefix": "string",
    "scheme": "string",
    "scope": "session",
    "scope_id": "string",
    "signature_header": "string",
    "signature_prefix": "string",
    "timestamp_header": "string",
    "tolerance_seconds": 0,
    "workspace_id": "string",
    "workspace_path": "string"
  },
  "timezone": "string"
}

EmitterContext

{
  "emitter_id": "string",
  "event_id": "string",
  "event_type": "string",
  "idempotency_key": "string",
  "managed_by": "string",
  "received_at": "string",
  "source": "string"
}

EmitterCreate

Used by: createEmitter

{
  "cron_expression": "string",
  "event_types": [
    "string"
  ],
  "input": {},
  "interval_seconds": 0,
  "kind": "string",
  "name": "string",
  "secret_env": "string",
  "source": "string",
  "source_config": {
    "actions": [
      "set"
    ],
    "auth_mode": "string",
    "basic_username": "string",
    "event_id_path": "string",
    "event_type_header": "string",
    "event_type_path": "string",
    "header": "string",
    "idempotency_header": "string",
    "job_ids": [
      {}
    ],
    "kinds": [
      "value"
    ],
    "prefix": "string",
    "scheme": "string",
    "scope": "session",
    "scope_id": "string",
    "signature_header": "string",
    "signature_prefix": "string",
    "timestamp_header": "string",
    "tolerance_seconds": 0,
    "workspace_id": "string",
    "workspace_path": "string"
  },
  "target": "string",
  "timezone": "string",
  "version": "string"
}

EmitterFire

Used by: fireEmitter

{
  "delivery_key": "string",
  "input": {}
}

EmitterList

Used by: listEmitters, syncEmitters

{
  "items": [
    {
      "code_origin": "string",
      "cron_expression": "string",
      "enabled": false,
      "event_types": [
        "string"
      ],
      "id": "string",
      "input": {},
      "interval_seconds": 0,
      "kind": "string",
      "last_registered_at": 0,
      "managed_by": "string",
      "name": "string",
      "next_due_at": 0,
      "orphaned": false,
      "revision": 0,
      "secret_env": "string",
      "source": "string",
      "source_config": {
        "actions": [
          {}
        ],
        "auth_mode": "string",
        "basic_username": "string",
        "event_id_path": "string",
        "event_type_header": "string",
        "event_type_path": "string",
        "header": "string",
        "idempotency_header": "string",
        "job_ids": [
          {}
        ],
        "kinds": [
          {}
        ],
        "prefix": "string",
        "scheme": "string",
        "scope": {},
        "scope_id": "string",
        "signature_header": "string",
        "signature_prefix": "string",
        "timestamp_header": "string",
        "tolerance_seconds": 0,
        "workspace_id": "string",
        "workspace_path": "string"
      },
      "sticky_paused": false,
      "target": "string",
      "timezone": "string",
      "version": "string"
    }
  ]
}

EmitterMetrics

Used by: emitterMetrics

{
  "dlq_depth": 0,
  "enabled_emitters": 0,
  "events_24h": {
    "key": 0
  },
  "memory_dispatch_failures": 0,
  "orphaned_emitters": 0,
  "total_emitters": 0
}

EmitterReplay

Used by: replayEmitterEvent

{
  "event_id": "string"
}

EmitterSourceConfig

{
  "actions": [
    "set"
  ],
  "auth_mode": "string",
  "basic_username": "string",
  "event_id_path": "string",
  "event_type_header": "string",
  "event_type_path": "string",
  "header": "string",
  "idempotency_header": "string",
  "job_ids": [
    {}
  ],
  "kinds": [
    "value"
  ],
  "prefix": "string",
  "scheme": "string",
  "scope": "session",
  "scope_id": "string",
  "signature_header": "string",
  "signature_prefix": "string",
  "timestamp_header": "string",
  "tolerance_seconds": 0,
  "workspace_id": "string",
  "workspace_path": "string"
}

EmitterSync

Used by: syncEmitters

{
  "bindings": [
    {
      "capability": "string",
      "code_origin": "string",
      "cron_expression": "string",
      "event_types": [
        "string"
      ],
      "input": {},
      "interval_seconds": 0,
      "secret_env": "string",
      "source": "string",
      "source_config": {
        "actions": [
          {}
        ],
        "auth_mode": "string",
        "basic_username": "string",
        "event_id_path": "string",
        "event_type_header": "string",
        "event_type_path": "string",
        "header": "string",
        "idempotency_header": "string",
        "job_ids": [
          {}
        ],
        "kinds": [
          {}
        ],
        "prefix": "string",
        "scheme": "string",
        "scope": {},
        "scope_id": "string",
        "signature_header": "string",
        "signature_prefix": "string",
        "timestamp_header": "string",
        "tolerance_seconds": 0,
        "workspace_id": "string",
        "workspace_path": "string"
      },
      "timezone": "string"
    }
  ]
}

EmitterUpdate

Used by: updateEmitter

{
  "enabled": false,
  "expected_revision": 0,
  "managed_by": "string"
}

EnrollWorker

Used by: enrollWorker

{
  "capacity": 0,
  "label": "string",
  "version": "string"
}

ErrorResponse

Used by: admitAccess, agentCapabilities, appendLogs, applyRuntimeSettings, bindSession, budgetStatus, budgetUsage, cancelEvalRun, cancelTraverser, claimTask, completeTask, createAccessPolicy, createApiToken, createBudget, createEmitter, createEvalCase, createEvalCaseSet, createIdentity, createSession, decideApproval, decideTags, deleteAccessPolicy, deleteArtifact, deleteBriefArtifact, deleteBudget, deleteEmitter, deleteEvalCase, deleteEvalCaseSet, deleteKnowledgeDocument, deleteMemory, deleteMemoryVector, deleteObservabilityWebhook, deletePublication, deleteRuntimeSettings, deleteSession, deleteSessionSecrets, discoverySettings, drainWorker, emitterEvents, emitterMetrics, enrolDid, enrollWorker, evalScores, evaluateAccess, fireEmitter, getAccessPolicy, getApproval, getArtifact, getBriefArtifact, getBudget, getCheckpoint, getConnector, getCredential, getDid, getEmitter, getEvalCaseSet, getEvalRun, getEventLog, getKnowledgeDocument, getMemoryVector, getObservabilitySettings, getObservabilityWebhook, getOwnConnector, getPath, getRunMetadata, getRuntimeSettings, getSession, getSessionSecrets, getTagPolicy, getTraverser, health, issueCredential, knowledgeStats, listAccessPolicies, listAgents, listApiTokens, listApprovals, listArtifacts, listBriefArtifacts, listBudgets, listCheckpoints, listConnectors, listCredentials, listDids, listEmitters, listEvalCaseSets, listEvalCases, listEvalRuns, listIdentities, listKnowledgeDocuments, listMemory, listPathProofs, listPublications, listRuntimeSettings, listSessions, listTagLedger, listTraversers, listUsage, listWorkers, memoryChanges, modelHealth, observabilityWebhookStatus, proposeTags, publishDiscovery, putArtifact, putBriefArtifact, putConnector, putKnowledgeBatch, putKnowledgeDocument, putObservabilityWebhook, putRuntimeSettings, putSessionSecrets, putTagPolicy, queryLogs, readMemory, recordRetrievalFeedback, recordUsage, redriveObservabilityWebhook, registerAgent, renewLease, replayEmitterEvent, reportProgress, requestApproval, resolveDid, restartTraverser, resumeTask, retentionApply, retentionPlan, retrievalFeedbackTotals, revokeApiToken, revokeConnector, revokeCredential, revokeIdentity, rotateApiToken, rotateIdentity, searchDiscovery, searchKnowledge, searchMemoryVectors, serverInfo, setMemoryVector, signPath, startEvalRun, stats, streamExecutionEvents, streamNodeLogs, submitTraverser, suspendTask, syncEmitters, testObservabilityWebhook, unregisterAgent, updateAccessPolicy, updateBudget, updateEmitter, updateEvalCase, updateEvalCaseSet, updateObservabilitySettings, updateRunMetadata, usageTotals, verifyCredential, verifyProof, writeCheckpoint, writeMemory

{
  "error": {
    "code": "string",
    "message": "string"
  },
  "request_id": "string"
}

EvalAssertion

One check over a case's outcome. `value` is the comparison operand: any JSON for `equals`/`not_equals`/`contains`/`not_contains`; a pattern for `regex`; one of string, number, boolean, object, array, null for `type`; a JSON Schema for `schema`; succeeded, failed, cancelled or timed_out for `status`; the `error.code` for `error_code`; a non-negative number for the bounds. `exists` takes none.

{
  "path": "string",
  "type": "equals",
  "value": {}
}

EvalAssertionResult

{
  "actual": {},
  "message": "string",
  "passed": false,
  "path": "string",
  "type": "equals"
}

EvalAssertionType

What one assertion checks. Path types read `path` from the traverser output; `status`, `error_code`, `max_duration_ms`, `max_cost_usd` and `max_tokens` read the outcome and take no path. `contains` and `regex` stringify non-string values as JSON; `min_length`/`max_length` apply to strings (characters) and arrays (items).

String enum: "equals" "not_equals" "contains" "not_contains" "regex" "exists" "type" "schema" "status" "error_code" "max_duration_ms" "max_cost_usd" "max_tokens" "min_length" "max_length"

"equals"

EvalCase

Used by: createEvalCase, updateEvalCase

{
  "assertions": [
    {
      "path": "string",
      "type": "equals",
      "value": {}
    }
  ],
  "case_set_id": "string",
  "created_at": 0,
  "id": "string",
  "input": {},
  "name": "string",
  "revision": 0,
  "tags": [
    "string"
  ],
  "updated_at": 0
}

EvalCaseInput

A case to add: the capability input and the assertions over its outcome. An empty or absent assertion list is the implicit `status: succeeded`.

Used by: createEvalCase

{
  "assertions": [
    {
      "path": "string",
      "type": "equals",
      "value": {}
    }
  ],
  "input": {},
  "name": "string",
  "tags": [
    "string"
  ]
}

EvalCaseList

Used by: listEvalCases

{
  "items": [
    {
      "assertions": [
        {
          "path": "string",
          "type": {},
          "value": {}
        }
      ],
      "case_set_id": "string",
      "created_at": 0,
      "id": "string",
      "input": {},
      "name": "string",
      "revision": 0,
      "tags": [
        "string"
      ],
      "updated_at": 0
    }
  ],
  "next_cursor": "string"
}

EvalCaseSet

Used by: createEvalCaseSet, getEvalCaseSet, updateEvalCaseSet

{
  "case_count": 0,
  "created_at": 0,
  "description": "string",
  "id": "string",
  "last_run": {
    "case_set_id": "string",
    "cost_complete": false,
    "cost_usd": 0.0,
    "created_at": 0,
    "duration_ms_p50": 0,
    "errored": 0,
    "failed": 0,
    "finished_at": 0,
    "id": "string",
    "label": "string",
    "pass_rate": 0.0,
    "passed": 0,
    "pending": 0,
    "revision": 0,
    "skipped": 0,
    "started_at": 0,
    "status": "string",
    "target": "string",
    "total": 0,
    "total_tokens": 0,
    "version": "string"
  },
  "name": "string",
  "principal": "string",
  "revision": 0,
  "target": "string",
  "updated_at": 0,
  "version": "string"
}

EvalCaseSetCreate

Used by: createEvalCaseSet

{
  "cases": [
    {
      "assertions": [
        {
          "path": "string",
          "type": {},
          "value": {}
        }
      ],
      "input": {},
      "name": "string",
      "tags": [
        "string"
      ]
    }
  ],
  "description": "string",
  "name": "string",
  "target": "string",
  "version": "string"
}

EvalCaseSetList

Used by: listEvalCaseSets

{
  "items": [
    {
      "case_count": 0,
      "created_at": 0,
      "description": "string",
      "id": "string",
      "last_run": {
        "case_set_id": "string",
        "cost_complete": false,
        "cost_usd": 0.0,
        "created_at": 0,
        "duration_ms_p50": 0,
        "errored": 0,
        "failed": 0,
        "finished_at": 0,
        "id": "string",
        "label": "string",
        "pass_rate": 0.0,
        "passed": 0,
        "pending": 0,
        "revision": 0,
        "skipped": 0,
        "started_at": 0,
        "status": "string",
        "target": "string",
        "total": 0,
        "total_tokens": 0,
        "version": "string"
      },
      "name": "string",
      "principal": "string",
      "revision": 0,
      "target": "string",
      "updated_at": 0,
      "version": "string"
    }
  ],
  "next_cursor": "string"
}

EvalCaseSetUpdate

Compare-and-set edit of a case set; unknown fields are rejected.

Used by: updateEvalCaseSet

{
  "description": "string",
  "expected_revision": 0,
  "name": "string",
  "target": "string",
  "version": "string"
}

EvalCaseUpdate

Compare-and-set edit of a case; unknown fields are rejected.

Used by: updateEvalCase

{
  "assertions": [
    {
      "path": "string",
      "type": "equals",
      "value": {}
    }
  ],
  "expected_revision": 0,
  "input": {},
  "name": "string",
  "tags": [
    "string"
  ]
}

EvalResult

One case's verdict in a run. `status` is pending, passed, failed, errored or skipped (patterned string, see `EvalRun.status`): `skipped` when the traverser was cancelled, `errored` when it failed or timed out without a `status`/`error_code` assertion expecting that, otherwise passed/failed by the assertions.

{
  "assertions": [
    {
      "actual": {},
      "message": "string",
      "passed": false,
      "path": "string",
      "type": "equals"
    }
  ],
  "case_id": "string",
  "case_name": "string",
  "cost_usd": 0.0,
  "duration_ms": 0,
  "error": {},
  "finished_at": 0,
  "output": {},
  "run_id": "string",
  "status": "string",
  "total_tokens": 0,
  "traverser_id": "string"
}

EvalRun

One execution of a case set. `status` is running, succeeded, failed or cancelled (a patterned string: these values already belong to `Status`, and the Go generator shares one constant namespace across every enum). Counters are maintained by settlement; `pass_rate` is passed over settled verdicts and null until one settles.

Used by: cancelEvalRun, startEvalRun

{
  "case_set_id": "string",
  "cost_complete": false,
  "cost_usd": 0.0,
  "created_at": 0,
  "duration_ms_p50": 0,
  "errored": 0,
  "failed": 0,
  "finished_at": 0,
  "id": "string",
  "label": "string",
  "pass_rate": 0.0,
  "passed": 0,
  "pending": 0,
  "revision": 0,
  "skipped": 0,
  "started_at": 0,
  "status": "string",
  "target": "string",
  "total": 0,
  "total_tokens": 0,
  "version": "string"
}

EvalRunDetail

Used by: getEvalRun

{
  "results": [
    {
      "assertions": [
        {
          "actual": {},
          "message": "string",
          "passed": false,
          "path": "string",
          "type": {}
        }
      ],
      "case_id": "string",
      "case_name": "string",
      "cost_usd": 0.0,
      "duration_ms": 0,
      "error": {},
      "finished_at": 0,
      "output": {},
      "run_id": "string",
      "status": "string",
      "total_tokens": 0,
      "traverser_id": "string"
    }
  ],
  "run": {
    "case_set_id": "string",
    "cost_complete": false,
    "cost_usd": 0.0,
    "created_at": 0,
    "duration_ms_p50": 0,
    "errored": 0,
    "failed": 0,
    "finished_at": 0,
    "id": "string",
    "label": "string",
    "pass_rate": 0.0,
    "passed": 0,
    "pending": 0,
    "revision": 0,
    "skipped": 0,
    "started_at": 0,
    "status": "string",
    "target": "string",
    "total": 0,
    "total_tokens": 0,
    "version": "string"
  }
}

EvalRunList

Used by: listEvalRuns

{
  "items": [
    {
      "case_set_id": "string",
      "cost_complete": false,
      "cost_usd": 0.0,
      "created_at": 0,
      "duration_ms_p50": 0,
      "errored": 0,
      "failed": 0,
      "finished_at": 0,
      "id": "string",
      "label": "string",
      "pass_rate": 0.0,
      "passed": 0,
      "pending": 0,
      "revision": 0,
      "skipped": 0,
      "started_at": 0,
      "status": "string",
      "target": "string",
      "total": 0,
      "total_tokens": 0,
      "version": "string"
    }
  ],
  "next_cursor": "string"
}

EvalRunRequest

Used by: startEvalRun

{
  "case_ids": [
    "string"
  ],
  "label": "string",
  "version": "string"
}

EvalScore

Finished runs of one set aggregated per version.

{
  "cases": 0,
  "cost_complete": false,
  "cost_usd": 0.0,
  "duration_ms_p50": 0,
  "errored": 0,
  "failed": 0,
  "last_finished_at": 0,
  "last_run_id": "string",
  "pass_rate": 0.0,
  "passed": 0,
  "runs": 0,
  "skipped": 0,
  "total_tokens": 0,
  "version": "string"
}

EvalScores

Used by: evalScores

{
  "case_set_id": "string",
  "items": [
    {
      "cases": 0,
      "cost_complete": false,
      "cost_usd": 0.0,
      "duration_ms_p50": 0,
      "errored": 0,
      "failed": 0,
      "last_finished_at": 0,
      "last_run_id": "string",
      "pass_rate": 0.0,
      "passed": 0,
      "runs": 0,
      "skipped": 0,
      "total_tokens": 0,
      "version": "string"
    }
  ]
}

EventLog

Used by: getEventLog

{
  "id": "string",
  "items": [
    {
      "created_at": 0,
      "data": {},
      "root_id": "string",
      "sequence": 0,
      "traverser_id": "string",
      "type": "string"
    }
  ],
  "root_id": "string"
}

ExecutionError

{
  "code": "string",
  "message": "string",
  "retryable": false
}

ExecutionEvent

{
  "created_at": 0,
  "data": {},
  "root_id": "string",
  "sequence": 0,
  "traverser_id": "string",
  "type": "string"
}

ExecutionPath

Used by: getPath

{
  "id": "string",
  "items": [
    {
      "attempt": 0,
      "attempts": [
        {
          "attempt": 0,
          "error": {},
          "finished_at": 0,
          "lease_expires_at": 0,
          "started_at": 0,
          "status": "string",
          "worker_id": "string"
        }
      ],
      "cancel_requested": false,
      "capability": "string",
      "created_at": 0,
      "deadline_at": 0,
      "error": {},
      "finished_at": 0,
      "id": "string",
      "idempotency_key": "string",
      "input": {},
      "input_bytes": 0,
      "input_truncated": false,
      "kind": "string",
      "label": "string",
      "max_attempts": 0,
      "operation_key": "string",
      "output": {},
      "output_bytes": 0,
      "parent_id": "string",
      "parent_step_id": "string",
      "principal": "string",
      "replay": {
        "reuse": "string",
        "reused_output": false,
        "source_id": "string"
      },
      "root_id": "string",
      "seq": 0,
      "session_id": "string",
      "started_at": 0,
      "status": "queued",
      "step_id": "string",
      "submitted_by": "string",
      "target": "string",
      "timeout_seconds": 0,
      "updated_at": 0,
      "version": "string"
    }
  ],
  "root_id": "string",
  "steps_returned": 0,
  "steps_total": 0,
  "truncated": false
}

Health

Used by: health

{
  "product": "string",
  "status": "string"
}

IdentityCreate

Used by: createIdentity

{
  "label": "string"
}

IdentityList

Used by: listIdentities

{
  "items": [
    {
      "algorithm": "string",
      "created_at": 0,
      "id": "string",
      "label": "string",
      "public_key": "string",
      "retired_at": 0,
      "revoked_at": 0,
      "state": "string"
    }
  ]
}

InboundDelivery

{
  "delivery_key": "string",
  "event_type": "string",
  "input": {},
  "raw_payload": {}
}

InboundEvent

Used by: replayEmitterEvent

{
  "created_at": 0,
  "delivery_key": "string",
  "emitter_id": "string",
  "error": {},
  "event_type": "string",
  "id": "string",
  "input": {},
  "raw_payload": {},
  "replay_of": "string",
  "status": "string",
  "traverser_id": "string"
}

InboundEventList

Used by: emitterEvents

{
  "items": [
    {
      "created_at": 0,
      "delivery_key": "string",
      "emitter_id": "string",
      "error": {},
      "event_type": "string",
      "id": "string",
      "input": {},
      "raw_payload": {},
      "replay_of": "string",
      "status": "string",
      "traverser_id": "string"
    }
  ]
}

Jwk

Ed25519 public key as a JSON Web Key.

{
  "crv": "string",
  "kty": "string",
  "x": "string"
}

KnowledgeBatchResult

Used by: putKnowledgeBatch

{
  "chunks": 0,
  "documents": 0,
  "items": [
    {
      "chunks": 0,
      "created": false,
      "doc_id": "string",
      "postings": 0,
      "revision": 0,
      "terms": 0,
      "tokens": 0
    }
  ]
}

KnowledgeChunk

{
  "citation": "string",
  "metadata": {
    "key": {}
  },
  "ordinal": 0,
  "page": 0,
  "text": "string",
  "tokens": 0
}

KnowledgeChunkBounds

{
  "default": 0,
  "max": 0,
  "min": 0
}

KnowledgeChunkInput

{
  "metadata": {
    "key": {}
  },
  "page": 0,
  "text": "string"
}

KnowledgeChunking

Server-side chunking of `text`; defaults 1200 characters with 100 overlap.

{
  "overlap": 0,
  "size": 0
}

KnowledgeDelete

Used by: deleteKnowledgeDocument

{
  "actor_id": "string",
  "doc_id": "string",
  "expected_revision": 0,
  "lease_token": "string",
  "root_id": "string",
  "scope": "session",
  "session_id": "string",
  "step_id": "string",
  "task_id": "string"
}

KnowledgeDeleted

`deleted:false` (no live document) carries no `revision`; a tombstone keeps the revision monotonic.

Used by: deleteKnowledgeDocument

{
  "deleted": false,
  "doc_id": "string",
  "revision": 0
}

KnowledgeDocument

`found:false` carries only `doc_id`. `items` is present only when `include_chunks` is true.

Used by: getKnowledgeDocument

{
  "chunks": 0,
  "created_at": 0,
  "doc_id": "string",
  "found": false,
  "items": [
    {
      "citation": "string",
      "metadata": {
        "key": {}
      },
      "ordinal": 0,
      "page": 0,
      "text": "string",
      "tokens": 0
    }
  ],
  "metadata": {
    "key": {}
  },
  "principal": "string",
  "revision": 0,
  "text_bytes": 0,
  "title": "string",
  "tokens": 0,
  "updated_at": 0
}

KnowledgeDocumentSummary

{
  "chunks": 0,
  "doc_id": "string",
  "metadata": {
    "key": {}
  },
  "revision": 0,
  "text_bytes": 0,
  "title": "string",
  "tokens": 0,
  "updated_at": 0
}

KnowledgeGet

Used by: getKnowledgeDocument

{
  "actor_id": "string",
  "doc_id": "string",
  "include_chunks": false,
  "lease_token": "string",
  "root_id": "string",
  "scope": "session",
  "session_id": "string",
  "step_id": "string",
  "task_id": "string"
}

KnowledgeHit

{
  "chunk_metadata": {
    "key": {}
  },
  "citation": "string",
  "doc_id": "string",
  "matched_terms": [
    "string"
  ],
  "metadata": {
    "key": {}
  },
  "ordinal": 0,
  "page": 0,
  "score": 0.0,
  "text": "string",
  "title": "string",
  "tokens": 0
}

KnowledgeHits

Used by: searchKnowledge

{
  "corpus_chunks": 0,
  "items": [
    {
      "chunk_metadata": {
        "key": {}
      },
      "citation": "string",
      "doc_id": "string",
      "matched_terms": [
        "string"
      ],
      "metadata": {
        "key": {}
      },
      "ordinal": 0,
      "page": 0,
      "score": 0.0,
      "text": "string",
      "title": "string",
      "tokens": 0
    }
  ],
  "next_offset": 0,
  "offset": 0,
  "scanned": 0,
  "strategy": "bm25",
  "terms": [
    "string"
  ],
  "top_k": 0,
  "total": 0
}

KnowledgeLimits

Bounds the store enforces, reported so clients can validate before sending.

{
  "chunk_bytes": 0,
  "chunk_chars": {
    "default": 0,
    "max": 0,
    "min": 0
  },
  "chunk_overlap_default": 0,
  "chunks_per_document": 0,
  "chunks_per_scope": 0,
  "doc_id_chars": 0,
  "documents_per_batch": 0,
  "documents_per_scope": 0,
  "list_limit": 0,
  "metadata_bytes": 0,
  "offset": 0,
  "query_chars": 0,
  "query_terms": 0,
  "term_chars": 0,
  "text_bytes": 0,
  "title_chars": 0,
  "top_k": 0
}

KnowledgeListQuery

Used by: listKnowledgeDocuments

{
  "actor_id": "string",
  "cursor": "string",
  "lease_token": "string",
  "limit": 0,
  "prefix": "string",
  "root_id": "string",
  "scope": "session",
  "session_id": "string",
  "step_id": "string",
  "task_id": "string"
}

KnowledgeListing

Used by: listKnowledgeDocuments

{
  "items": [
    {
      "chunks": 0,
      "doc_id": "string",
      "metadata": {
        "key": {}
      },
      "revision": 0,
      "text_bytes": 0,
      "title": "string",
      "tokens": 0,
      "updated_at": 0
    }
  ],
  "next_cursor": "string"
}

KnowledgePut

Write or replace one document: authority fields plus the document fields.

Used by: putKnowledgeDocument

{
  "actor_id": "string",
  "chunk": {
    "overlap": 0,
    "size": 0
  },
  "chunks": [
    {
      "metadata": {
        "key": {}
      },
      "page": 0,
      "text": "string"
    }
  ],
  "doc_id": "string",
  "expected_revision": 0,
  "lease_token": "string",
  "metadata": {
    "key": {}
  },
  "root_id": "string",
  "scope": "session",
  "session_id": "string",
  "step_id": "string",
  "task_id": "string",
  "text": "string",
  "title": "string"
}

KnowledgePutBatch

One transaction: any failure writes nothing. Duplicate `doc_id`s are rejected and the combined text is bounded to 4 MiB.

Used by: putKnowledgeBatch

{
  "actor_id": "string",
  "documents": [
    {
      "chunk": {
        "overlap": 0,
        "size": 0
      },
      "chunks": [
        {
          "metadata": {
            "key": {}
          },
          "page": 0,
          "text": "string"
        }
      ],
      "doc_id": "string",
      "expected_revision": 0,
      "metadata": {
        "key": {}
      },
      "text": "string",
      "title": "string"
    }
  ],
  "lease_token": "string",
  "root_id": "string",
  "scope": "session",
  "session_id": "string",
  "step_id": "string",
  "task_id": "string"
}

KnowledgePutDocument

One document in a batch: exactly one of `text` (with optional `chunk`) or `chunks`.

{
  "chunk": {
    "overlap": 0,
    "size": 0
  },
  "chunks": [
    {
      "metadata": {
        "key": {}
      },
      "page": 0,
      "text": "string"
    }
  ],
  "doc_id": "string",
  "expected_revision": 0,
  "metadata": {
    "key": {}
  },
  "text": "string",
  "title": "string"
}

KnowledgeScope

Memory authority fields shared by every knowledge request; `scope` resolves ownership exactly like `memory/read`.

Used by: knowledgeStats

{
  "actor_id": "string",
  "lease_token": "string",
  "root_id": "string",
  "scope": "session",
  "session_id": "string",
  "step_id": "string",
  "task_id": "string"
}

KnowledgeSearch

Used by: searchKnowledge

{
  "actor_id": "string",
  "doc_id": "string",
  "filters": {
    "key": {}
  },
  "lease_token": "string",
  "min_score": 0.0,
  "offset": 0,
  "query": "string",
  "root_id": "string",
  "scope": "session",
  "session_id": "string",
  "step_id": "string",
  "task_id": "string",
  "top_k": 0
}

KnowledgeStats

Used by: knowledgeStats

{
  "average_chunk_tokens": 0.0,
  "chunks": 0,
  "documents": 0,
  "limits": {
    "chunk_bytes": 0,
    "chunk_chars": {
      "default": 0,
      "max": 0,
      "min": 0
    },
    "chunk_overlap_default": 0,
    "chunks_per_document": 0,
    "chunks_per_scope": 0,
    "doc_id_chars": 0,
    "documents_per_batch": 0,
    "documents_per_scope": 0,
    "list_limit": 0,
    "metadata_bytes": 0,
    "offset": 0,
    "query_chars": 0,
    "query_terms": 0,
    "term_chars": 0,
    "text_bytes": 0,
    "title_chars": 0,
    "top_k": 0
  },
  "postings": 0,
  "scope": "session",
  "strategy": "bm25",
  "terms": 0,
  "text_bytes": 0,
  "tokens": 0
}

KnowledgeStrategy

Ranking strategy; always `bm25` (k1 = 1.2, b = 0.75). No embedding index exists.

String enum: "bm25"

"bm25"

KnowledgeWriteResult

Used by: putKnowledgeDocument

{
  "chunks": 0,
  "created": false,
  "doc_id": "string",
  "postings": 0,
  "revision": 0,
  "terms": 0,
  "tokens": 0
}

Lease

Used by: renewLease, resumeTask, suspendTask

{
  "id": "string",
  "lease_token": "string",
  "worker_id": "string"
}

LeaseRenewal

Used by: renewLease

{
  "cancel_requested": false,
  "lease_expires_at": 0
}

LogAppendRequest

Used by: appendLogs

{
  "entries": [
    {
      "fields": {
        "key": {}
      },
      "level": "trace",
      "logged_at": 0,
      "message": "string",
      "source": "string",
      "stream": "stdout"
    }
  ],
  "entry": {
    "fields": {
      "key": {}
    },
    "level": "trace",
    "logged_at": 0,
    "message": "string",
    "source": "string",
    "stream": "stdout"
  },
  "lease_token": "string",
  "step_id": "string",
  "task_id": "string",
  "traverser_id": "string"
}

LogEntry

One node log line. `message` is truncated to the namespace's byte bound.

{
  "fields": {
    "key": {}
  },
  "level": "trace",
  "logged_at": 0,
  "message": "string",
  "source": "string",
  "stream": "stdout"
}

LogLevel

String enum: "trace" "debug" "info" "warn" "error" "fatal" "log"

"trace"

LogPage

Used by: queryLogs

{
  "items": [
    {
      "attempt": 0,
      "created_at": 0,
      "fields": {
        "key": {}
      },
      "level": "trace",
      "logged_at": 0,
      "message": "string",
      "root_id": "string",
      "sequence": 0,
      "source": "string",
      "stream": "stdout",
      "traverser_id": "string",
      "truncated": false
    }
  ],
  "next_cursor": 0,
  "root_id": "string",
  "traverser_id": "string"
}

LogReceipt

Used by: appendLogs

{
  "accepted": 0,
  "attempt": 0,
  "first_sequence": 0,
  "last_sequence": 0,
  "max_message_bytes": 0,
  "root_id": "string",
  "traverser_id": "string",
  "truncated": 0
}

LogRecord

{
  "attempt": 0,
  "created_at": 0,
  "fields": {
    "key": {}
  },
  "level": "trace",
  "logged_at": 0,
  "message": "string",
  "root_id": "string",
  "sequence": 0,
  "source": "string",
  "stream": "stdout",
  "traverser_id": "string",
  "truncated": false
}

LogStream

String enum: "stdout" "stderr" "app"

"stdout"

MemoryChangeAction

Whether a change event records a write or a tombstone.

String enum: "set" "delete"

"set"

MemoryChangeEvent

One durable change. `value` carries the written JSON only for value sets whose canonical JSON is at most 65536 bytes; larger payloads set `value_omitted`.

{
  "action": "set",
  "created_at": 0,
  "key": "string",
  "kind": "value",
  "principal": "string",
  "revision": 0,
  "scope": "session",
  "scope_id": "string",
  "sequence": 0,
  "value": {},
  "value_omitted": false
}

MemoryChangeFeed

Used by: memoryChanges

{
  "items": [
    {
      "action": "set",
      "created_at": 0,
      "key": "string",
      "kind": "value",
      "principal": "string",
      "revision": 0,
      "scope": "session",
      "scope_id": "string",
      "sequence": 0,
      "value": {},
      "value_omitted": false
    }
  ],
  "next_cursor": 0,
  "oldest_sequence": 0
}

MemoryChangeQuery

Used by: memoryChanges

{
  "actor_id": "string",
  "after": 0,
  "lease_token": "string",
  "limit": 0,
  "prefix": "string",
  "root_id": "string",
  "scope": "session",
  "session_id": "string",
  "step_id": "string",
  "task_id": "string"
}

MemoryDelete

Used by: deleteMemory

{
  "actor_id": "string",
  "expected_revision": 0,
  "key": "string",
  "root_id": "string",
  "scope": "session",
  "session_id": "string"
}

MemoryEntry

One live entry. `expires_at` is present for value entries (null when the entry has no TTL); `dimension` is present for vector entries.

{
  "dimension": 0,
  "expires_at": 0,
  "key": "string",
  "revision": 0,
  "updated_at": 0
}

MemoryKey

Used by: readMemory

{
  "actor_id": "string",
  "key": "string",
  "root_id": "string",
  "scope": "session",
  "session_id": "string"
}

MemoryKind

What a listed or changed memory entry holds: a JSON value or an embedding.

String enum: "value" "vector"

"value"

MemoryListQuery