SettleMesh API Docs

One API key for models, tools, apps, agents, and user services.

Use the CLI when a human or agent is operating in a terminal. Use HTTP when embedding SettleMesh in a server. Both use the same SettleMesh account, credits, service catalog, and execution contracts.

Base URL

HTTP endpoint

https://settlemesh.io

Auth

Bearer key

Authorization: Bearer $SETTLE_API_KEY

CLI

Install package

npm install settlemesh@latest --prefer-online

Agents

Read first

/agent.md

CLI quickstart

npm install settlemesh@latest --prefer-online
	./node_modules/.bin/settlemesh doctor --require-latest
	./node_modules/.bin/settlemesh login
	./node_modules/.bin/settlemesh search "web research" --json
	./node_modules/.bin/settlemesh tool show web.search --json
	./node_modules/.bin/settlemesh tool call web.search --input '{"q":"SettleMesh docs"}' --json

HTTP quickstart

curl "https://settlemesh.io/v1/services/search?q=web+research" \
  -H "Authorization: Bearer $SETTLE_API_KEY"

curl "https://settlemesh.io/v1/tools/web.search" \
  -H "Authorization: Bearer $SETTLE_API_KEY"

Service Search

Search before invoking.

GET /v1/services/search?q=... returns service cards and matched operations.

GET /v1/services/{id} returns the card, category, descriptions, entrypoints, and operation refs.

Tool Protocol

Inspect exact schemas.

GET /v1/tools lists executable tools. GET /v1/tools/{id} shows input schema, pricing metadata, and wait behavior.

POST /v1/tools/{id}/call invokes the tool. Prefer the CLI wrapper for humans and agents.

OpenAI-compatible

Use existing SDKs.

Text model routes support OpenAI-style clients with baseURL=https://settlemesh.io/v1 and your SettleMesh key.

curl https://settlemesh.io/v1/chat/completions \
  -H "Authorization: Bearer $SETTLE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model":"openrouter/auto","messages":[{"role":"user","content":"Hello"}]}'

Apps, Agents, Workers

Publish services other users can call.

Deploy apps with settlemesh deploy, publish App APIs/commands, upload hosted agents, or share local worker offers. Published resources become searchable service cards when approved.