DOCUMENTATIONv2

POST

Agent-native Context Mesh

Enroll workspace knowledge agent

/api/v2/workspaces/{workspace_id}/knowledge-agents

AUTHENTICATIONBearer token · workspaces:writeAUTHORITATIVE OWNERcontext-meshCONTRACT AUTHORITYGenerated Rust OpenAPISTATUSSource ready · production listed

PURPOSE + BUSINESS CONTEXT

Current human workspace OWNER enrolls an Ed25519 agent using fresh WORKLOAD_CLIENT_REGISTRATION approval and proof of key possession. Only context:read/query/feedback/propose/subscribe; no financial authority. tenant_uuid must match workspace_id.

WHEN THIS CALL IS USEFUL

Call this when a tenant member, team administrator, account client, or workspace-aware agent needs to apply the documented enroll workspace knowledge agent transition after re-reading the current authoritative state so it can create and select isolated workspaces and govern invitations, memberships, roles, and active execution context.

OUTCOME · Create or advance

What changes

Creates or advances only the enroll workspace knowledge agent resource described by this contract after authorization, validation, policy, and idempotency gates pass.

WHY IT MATTERS

Gives people and agents a contract-backed way to advance enroll workspace knowledge agent.
Keeps teams, resources, policies, credentials, wallets, and activity partitioned by workspace while allowing one identity to participate in multiple bounded environments.

ISOLATION + AUTHORITY

Tenant, identity, workspace, invitation, membership, role, active-workspace selection, resource ownership, wallet, policy, and entitlement boundaries remain distinct. Membership or selection does not grant tenant administration, wallet signing, payment, settlement, publisher, matching, or trading authority beyond separately evaluated scopes and policy.

BEFORE YOU CALL

Authenticate at the documented boundary: bearer+scope.
Supply the required workspace_id (path), request (body) exactly as defined by the live contract.
Use one Idempotency-Key only for retries of the same byte-equivalent logical mutation.
Resolve the tenant, authenticated identity, target workspace, current membership and role version, invitation state, and last-owner safeguards.

WHAT TO DO NEXT

Re-read the workspace roster and active-workspace selection to confirm the resulting invitation, membership, role, or context state.
After an ambiguous result, reconcile current state before retrying; preserve last-owner and concurrent-version safeguards.

AGENT GUIDANCE

Use enroll workspace knowledge agent only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Supply the required workspace_id (path), request (body) exactly as defined by the live contract.
Treat workspace creation, invitation, acceptance, active membership, role assignment, active-context selection, revocation, and dependent-resource access as separate state transitions.
After a timeout or conflict, read authoritative state before deciding whether an equivalent retry is safe.

MACHINE CONTRACT

The exact deployed parameters, schemas, responses, security requirements, and Hybrid-Chain agent metadata are authoritative at this operation's production OpenAPI JSON Pointer. The readable tables below add integration guidance; the deployed OpenAPI controls if guidance and the machine contract ever differ.

Open the authoritative production contract ↗

EXTENDED INTEGRATION GUIDANCE

Readable request and response reference

Examples illustrate integration intent; the referenced OpenAPI operation and component schemas define the executable shape.

PARAMETERS

Headers, path, query, and body

NAMELOCATIONPRESENCETYPE / RULES / PURPOSE

AuthorizationheaderRequired

Bearer tokenCredential containing workspaces:write authority.EXAMPLEBearer hc_live_…

workspace_idpathRequired

identifierStable workspace id selecting the exact resource addressed by this route.EXAMPLEworkspace-id-01

X-Request-IDheaderOptional

stringOptional caller correlation identifier. The gateway emits the effective value on the response.

Idempotency-KeyheaderRequired

ASCII string · 1–128Caller-generated stable key reused for retries of the same logical mutation.

Content-DigestheaderRequired

stringRFC 9530 sha-256 digest of the exact transmitted request-body bytes.

Signature-InputheaderRequired

stringRFC 9421 sig1 input covering @method, @path, content-digest, content-type, and idempotency-key, with created, expires, nonce, keyid, and alg=ed25519.

SignatureheaderRequired

stringRFC 9421 sig1 Ed25519 signature made by an active key registered to the bearer client.

allowed_scopesbodyRequired

string[]Exact least-privilege capabilities allowed for this workload; unknown or financial scopes are rejected by the knowledge-agent flow.

labelbodyRequired

stringAuthoritative label value defined by this V2 schema.

proofbodyRequired

stringBase64url Ed25519 proof of possession over the operation's published canonical statement.

public_key_jwkbodyRequired

PublicSigningJwkPublic OKP/Ed25519 JWK. Private key parameters are rejected and must never be transmitted.

step_up_tokenbodyRequired

stringFresh, one-use, purpose-bound hcsu_ authorization created by the authenticated human session.

tenant_uuidbodyRequired

stringStable tenant boundary. Omission is accepted only where the operation explicitly selects the global tenant.EXAMPLE7d44d4fbf2c14a65a7074692b2b77472

REQUEST

JSON body example

{
  "allowed_scopes": [
    "example-allowed-scope"
  ],
  "label": "example-label",
  "proof": "example-proof",
  "public_key_jwk": {
    "crv": "example-crv",
    "kty": "example-kty",
    "x": "example-x"
  },
  "step_up_token": "example-step-up-token",
  "tenant_uuid": "7d44d4fbf2c14a65a7074692b2b77472"
}

STABLE ERROR CODES

Branch on the code, then follow the recovery action

These codes are published by the authoritative gateway contract for this endpoint. Treat message as safe diagnostic text; integrations should branch on code and HTTP status.

STATUSCODEMEANING

400invalid_jsonThe JSON body is malformed or fails the published workload schema.

400invalid_security_requestThe workload identity, scope, public key, proof, or step-up request is invalid.

401invalid_credentialsThe human workspace-owner bearer or proof-of-possession credential is invalid.

403step_up_requiredCurrent workspace ownership and fresh purpose-bound approval are required.

404workload_client_not_foundThe requested workspace knowledge agent was not found.

409security_conflictThe knowledge-agent lifecycle transition conflicts with current state.

503identity_security_unavailableThe authoritative Identity security service is temporarily unavailable.

RESPONSES

Status and payload examples

201Knowledge credential operation completed.Mutation completed · JSON RESPONSE+

{
  "algorithm": "example-algorithm",
  "allowed_scopes": [
    "example-allowed-scope"
  ],
  "client_id": "hcwc_knowledge_agent_01",
  "created_at": "2026-09-02T18:30:00Z",
  "label": "example-label",
  "public_key_jwk": {
    "crv": "example-crv",
    "kty": "example-kty",
    "x": "example-x"
  },
  "request_signing_key_id": "hck_ed25519_01",
  "revoked_at": "2026-09-02T18:30:00Z",
  "status": "ACTIVE",
  "tenant_uuid": "7d44d4fbf2c14a65a7074692b2b77472"
}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then re-read the workspace roster and active-workspace selection to confirm the resulting invitation, membership, role, or context state.
RETRY SAFETY: Do not repeat a successful mutation merely to confirm it. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions.
STATE RECONCILIATION: Persist returned identifiers, versions, commitments, and receipts. Re-read the exact Context Mesh object and its version, participant commitments, delivery state, and acknowledgement before resubmitting a signed mutation.

400Malformed body, signature, or identifier.Request must change · JSON RESPONSE+

{
  "code": "invalid_json",
  "message": "The JSON body is malformed or fails the published workload schema."
}

INTEGRATION DECISIONinvalid_json

CALLER ACTION: Rebuild the request from the live OpenAPI operation and correct the rejected method, media type, header, parameter, or body field.
RETRY SAFETY: Do not retry the same invalid request. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions.
STATE RECONCILIATION: Compare the submitted values with the documented constraints before another call. Re-read the exact Context Mesh object and its version, participant commitments, delivery state, and acknowledgement before resubmitting a signed mutation.
ESCALATE WHEN: Escalate when participant authority, disclosure commitment, signature key, nonce history, or object version cannot be reconciled without exposing private memory.

401Human bearer is missing or invalid.Authentication required · JSON RESPONSE+

{
  "code": "invalid_credentials",
  "message": "The human workspace-owner bearer or proof-of-possession credential is invalid."
}

INTEGRATION DECISIONinvalid_credentials

CALLER ACTION: Discard the rejected credential, complete the documented authentication or reassertion flow, and rebuild any request signature with fresh timestamps and nonces.
RETRY SAFETY: Retry only with a newly valid credential and fresh replay-protection values. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions.
STATE RECONCILIATION: Assume the outcome is unknown only when the connection failed after transmission; otherwise authentication failed before domain work. Re-read the exact Context Mesh object and its version, participant commitments, delivery state, and acknowledgement before resubmitting a signed mutation.
ESCALATE WHEN: Escalate when participant authority, disclosure commitment, signature key, nonce history, or object version cannot be reconciled without exposing private memory.

403Current ownership, signing authority, scope ceiling, or fresh authenticator approval failed.Authority or policy denied · JSON RESPONSE+

{
  "code": "step_up_required",
  "message": "Current workspace ownership and fresh purpose-bound approval are required."
}

INTEGRATION DECISIONstep_up_required

CALLER ACTION: Verify the exact scope, tenant or workspace membership, owner boundary, step-up purpose, feature policy, and resource eligibility. Never broaden authority automatically.
RETRY SAFETY: Do not retry until the missing authority or policy condition has been deliberately resolved with least privilege.
STATE RECONCILIATION: Confirm the caller and resource resolve to the same authority boundary for workspace-bound Context Mesh objects, grants, offers, requests, agreements, deliveries, and acknowledgements.
ESCALATE WHEN: Escalate when participant authority, disclosure commitment, signature key, nonce history, or object version cannot be reconciled without exposing private memory.

404Workspace knowledge credential not found.Resource not visible · JSON RESPONSE+

{
  "code": "workload_client_not_found",
  "message": "The requested workspace knowledge agent was not found."
}

INTEGRATION DECISIONworkload_client_not_found

CALLER ACTION: Verify the canonical identifier and authenticated owner boundary. A 404 may intentionally conceal a resource outside the caller's authority.
RETRY SAFETY: Do not retry the unchanged identifier repeatedly. Refresh the relevant collection or lookup before choosing another identifier.
STATE RECONCILIATION: Re-read the exact Context Mesh object and its version, participant commitments, delivery state, and acknowledgement before resubmitting a signed mutation.
ESCALATE WHEN: Escalate when participant authority, disclosure commitment, signature key, nonce history, or object version cannot be reconciled without exposing private memory.

503Authoritative Identity service unavailable.Dependency unavailable or outcome uncertain · JSON RESPONSE+

{
  "code": "identity_security_unavailable",
  "message": "The authoritative Identity security service is temporarily unavailable."
}

INTEGRATION DECISIONidentity_security_unavailable

CALLER ACTION: Preserve the exact request and treat the outcome as uncertain until authoritative state proves whether it committed.
RETRY SAFETY: Reconcile before retrying. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions. Use bounded backoff with jitter.
STATE RECONCILIATION: Re-read the exact Context Mesh object and its version, participant commitments, delivery state, and acknowledgement before resubmitting a signed mutation.
ESCALATE WHEN: Escalate when participant authority, disclosure commitment, signature key, nonce history, or object version cannot be reconciled without exposing private memory.

OPERATIONAL NOTES

Security and lifecycle guarantees

Requires current human workspace ownership, workspaces:write, fresh WORKLOAD_CLIENT_REGISTRATION authenticator approval and Ed25519 proof of possession. Only context:read/query/feedback/propose/subscribe scopes are allowed. No wallet or financial authority.
The Rust gateway validates the public contract and routes only to the authoritative owner; clients never address internal services directly.
Mutations are retry-safe only when the same Idempotency-Key and canonical request body are reused.
The tables and examples are derived from the current gateway source OpenAPI. Re-fetch the deployed OpenAPI before execution; deployment status is shown separately on this page.
Only parameters present in the OpenAPI operation are accepted; undocumented query keys fail closed with HTTP 422.

DOCUMENTATION STATUS

This route is implemented in canonical gateway source and appears in the production OpenAPI snapshot observed 2026-09-11T06:35:11.572Z. Authentication, tenant, feature, venue, and market policy still apply.

Verify the exact production OpenAPI operation ↗Return to the V2 directory ↗