Agents

Available from @codespar/sdk 0.12.0; the version on npm is 0.16.18. When these docs build, the examples on this page are compiled against @codespar/sdk 0.16.18, the version this site installs: a call that does not type-check against it fails the build.

Every call below is cs.api reaching one operation of the OpenAPI document this page was generated from; the REST client overview explains request, response, the option bag and the errors. The values are placeholders shaped by the document.

import { CodeSpar } from "@codespar/sdk";

const cs = new CodeSpar({ apiKey: process.env.CODESPAR_API_KEY });

GET /v1/agents

List registered agents

const result = await cs.api.get("/v1/agents");

Parameters, body and every documented response: GET /v1/agents in the HTTP reference.

POST /v1/agents

Register an agent identity and mint its first signing key

const result = await cs.api.post("/v1/agents", {
  body: {
    agent_id: "agt_0000000000000000",
    display_name: "Example",
    principal_ref: "string",
    runtime: {
      kind: "sdk",
      detail: "string"
    },
    role: "string"
  }
});

Parameters, body and every documented response: POST /v1/agents in the HTTP reference.

POST /v1/agents/{agentId}/keys/rotate

Mint a new signing key and retire the current one

const result = await cs.api.post("/v1/agents/{agentId}/keys/rotate", {
  path: {
    agentId: "agt_0000000000000000"
  }
});

Parameters, body and every documented response: POST /v1/agents/{agentId}/keys/rotate in the HTTP reference.

POST /v1/agents/{agentId}/keys/{kid}/revoke

Revoke one signing key

const result = await cs.api.post("/v1/agents/{agentId}/keys/{kid}/revoke", {
  path: {
    agentId: "agt_0000000000000000",
    kid: "string"
  }
});

Parameters, body and every documented response: POST /v1/agents/{agentId}/keys/{kid}/revoke in the HTTP reference.

POST /v1/agents/{did}/revoke

Revoke an agent identity

const result = await cs.api.post("/v1/agents/{did}/revoke", {
  path: {
    did: "did:web:codespar.dev:org:agent"
  }
});

Parameters, body and every documented response: POST /v1/agents/{did}/revoke in the HTTP reference.

POST /v1/agents/{did}/suspend

Suspend one agent's spend

const result = await cs.api.post("/v1/agents/{did}/suspend", {
  path: {
    did: "did:web:codespar.dev:org:agent"
  },
  body: {
    reason: "string"
  }
});

Parameters, body and every documented response: POST /v1/agents/{did}/suspend in the HTTP reference.