Skip to content

sp_api → sp migration

Map for updating @spcode/plugin skills from sp_api endpoint=… to sp argv.

sp_api endpointPlanned sp commandREST (primary)
list_applicationssp app list --jsonGET /api/applications/list
agent_statussp app status <appId> --jsonGET /api/applications/{appId}/agent-status
recent_replayssp app replays <appId> --jsonGET /api/applications/{appId}/replays/recent
find_traces_by_attrsp trace find … --jsonPOST /api/traces/find-by-attr
get_trace_summarysp trace get <traceId> --jsonGET /api/traces/{traceId}/summary
query_replay_metadatasp replay metadata <replayId> --jsonstorage/schedule metadata
query_plan_fail_casessp replay case list --plan <id> --failed --jsonreport APIs
query_replay_casesp replay case list … --jsonreport/storage
diff_detailsp replay diff get <diffId> --out-dir … --jsonGET /api/report/queryDiffMsgById/{id}
compare_resultsp replay compare … --jsonschedule/report compare
record_datasp record query … --jsonPOST /api/storage/record/query
download_record_logssp record logs download … --json/api/record-logs/download
record_log_overviewsp record logs overview … --json/api/record-logs/overview
download_replay_logssp replay logs download … --json/api/replay-logs/download
replay_log_overviewsp replay logs overview … --json/api/replay-logs/overview
app_configsp config agent load --app <id> --jsonPOST /api/config/agent/load
multi_service_configsp config legacy multiservice load …GET /api/getMultiServiceConfig

Behavioral differences

Topicsp_api (today)sp (target)
OutputMixed text + files under .sp-code/JSON envelope + artifact path
Scope directoryPlugin manages .sp-code/{scope}/--out-dir flag explicit
AuthPlugin resolveSpUrls + configSP_TOKEN + profiles
Permissionsctx.ask (partially disabled)Host tool policy

Source tools (not in public sp)

spcode toolPublic sp
sp_readNot exposed — proprietary source; use internal tooling only
sp_grepNot exposed — same
diagnoseSkill composing sp replay * + sp record *

Migration checklist for skill authors

  1. Replace sp_api shell snippets with sp … --json
  2. Parse ok / data envelope; read artifacts from data.artifact
  3. Set SP_API_URL and SP_TOKEN in agent host config
  4. Remove hardcoded endpoint enum lists from skill markdown