Tool Calls

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/tool-calls

List tool calls across the project's sessions

const result = await cs.api.get("/v1/tool-calls");

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

GET /v1/tool-calls/stats

Tool-call figures per server

const result = await cs.api.get("/v1/tool-calls/stats");

Parameters, body and every documented response: GET /v1/tool-calls/stats in the HTTP reference.

GET /v1/tool-calls/{id}

Read one tool call

const result = await cs.api.get("/v1/tool-calls/{id}");

Parameters, body and every documented response: GET /v1/tool-calls/{id} in the HTTP reference.

GET /v1/tool-calls/{id}/payment-status

Where a tool call's payment got to

const result = await cs.api.get("/v1/tool-calls/{id}/payment-status", {
  path: {
    id: "tc_0000000000000000"
  }
});

Parameters, body and every documented response: GET /v1/tool-calls/{id}/payment-status in the HTTP reference.

GET /v1/tool-calls/{id}/payment-status/stream

The same payment status, pushed as it changes (SSE)

const result = await cs.api.get("/v1/tool-calls/{id}/payment-status/stream", {
  path: {
    id: "tc_0000000000000000"
  }
});
// result is the raw Response: the body is a text/event-stream.

Parameters, body and every documented response: GET /v1/tool-calls/{id}/payment-status/stream in the HTTP reference.

GET /v1/tool-calls/{id}/verification-status

Where a tool call's identity check got to

const result = await cs.api.get("/v1/tool-calls/{id}/verification-status", {
  path: {
    id: "tc_0000000000000000"
  }
});

Parameters, body and every documented response: GET /v1/tool-calls/{id}/verification-status in the HTTP reference.

GET /v1/tool-calls/{id}/verification-status/stream

The same verification status, pushed as it changes (SSE)

const result = await cs.api.get("/v1/tool-calls/{id}/verification-status/stream", {
  path: {
    id: "tc_0000000000000000"
  }
});
// result is the raw Response: the body is a text/event-stream.

Parameters, body and every documented response: GET /v1/tool-calls/{id}/verification-status/stream in the HTTP reference.