Docs

Quickstart to send your first trace.

3-step quickstart

  1. 1. Install: pip install agentscope-sdk or npm install @agentscope/sdk
  2. 2. Set API key: export AGENTSCOPE_API_KEY=...
  3. 3. Send first trace and confirm: trace received: run_...

Available SDK methods

Public methods currently available in the Python and TypeScript SDKs.

Python SDK

Package: agentscope

  • init(telemetry=None)
  • observe_run(...)
  • observe_span(...)
  • auto_trace(providers=None)
  • auto_instrument(providers=None, ...)
  • coding_agent_run(agent_name="coding_agent")
  • instrument_coding_agent(fn)
  • read_file(path, encoding="utf-8")
  • write_file(path, content, encoding="utf-8")
  • run_command(command, ...)

Trace facade

trace.auto(...)

trace.log(message, ...)

trace.update_span(span_id, data)

TypeScript SDK

Package: @agentscope/sdk

  • observeRun(workflowName, fn, options?)
  • observeSpan(name, fn, options?)
  • addArtifact(kind, payload, spanId?)
  • updateSpan(spanId, data)
  • autoTrace(providers?)
  • autoInstrument(providers?)
  • codingAgentRun(fn, options?)
  • instrumentCodingAgent(fn)
  • readFile(filePath, encoding?)
  • writeFile(filePath, content, encoding?)
  • runCommand(command, options?)
  • flush()

Trace facade

trace.auto(...)

trace.log(message, options?)

trace.updateSpan(spanId, data)

SecurityStatusPrivacyTerms