Buscar. Describe. Quote. Run.
GET /api/capabilities searches by natural-language query and category. Describe the selected slug before constructing input: its schema is the source of truth for Campos, pricing, Archivo requirements, and execution support.
- BuscarFind candidates with
?q=Comprimir%20pdf. - DescribeRead
execution.machine_run_statusand the input schema. - QuoteConfirm price, wallet clearance, and save the returned
quote_id. - EjecutarSend the same input, quote ID, and a unique idempotency key.
export SWARME_API_KEY="YOUR_SWARME_API_KEY"
export SWARME_BASE_URL="https://YOUR_SWARME_HOST"
curl "$SWARME_BASE_URL/api/capabilities?q=Comprimir%20pdf&limit=10"
curl "$SWARME_BASE_URL/api/capabilities/compress-pdf"
curl -X POST "$SWARME_BASE_URL/api/capabilities/uuid-generator/quote" \
-H "Authorization: Bearer $SWARME_API_KEY" -H "Content-Type: application/json" \
-d '{"input":{},"client_type":"api"}'
curl -X POST "$SWARME_BASE_URL/api/capabilities/uuid-generator/run" \
-H "Authorization: Bearer $SWARME_API_KEY" \
-H "Idempotency-Key: YOUR_UNIQUE_REQUEST_ID" -H "Content-Type: application/json" \
-d '{"input":{},"client_type":"api","quote_id":"YOUR_QUOTE_ID"}'Authenticate with least privilege.
Crear a scoped API key from Dashboard → Developers. Send Authorization: Bearer YOUR_SWARME_API_KEY. Never put a key in client-side code, URLs, logs, or a repository.
Scopes
Use only the needed scopes: capabilities:read, capabilities:quote, capabilities:run, uploads:write, artifacts:read, and billing:read.
Spend limits
Each client may have a USD cap. Check GET /api/account/balance before paid work; wallet or spend-limit failures are hard stops.
Idempotency
Use one stable Idempotency-Key per logical quote/run attempt. Replays return the original work; a key cannot safely represent different input. Paid API runs may require it.
Quotes
Quote immediately before execution and pass its quote_id. Surface the price or policy failure a the user.
Use short-lived Subir sessions.
Crear a session for the selected slug, Subir raw bytes a its returned URL with the dedicated token, then supply Subir_id (or Subir_ids) in quote and run input. Validate filename, MIME type, and Tamaño against describe. Never reuse or log an Subir token.
# Crear a session. Keep its Subir_token Privado.
curl -X POST "$SWARME_BASE_URL/api/capabilities/compress-pdf/upload-session" \
-H "Authorization: Bearer $SWARME_API_KEY" -H "Content-Type: application/json" \
-d '{"input":{"filename":"Documento.PDF","content_type":"application/PDF","Tamaño_bytes":12345},"client_type":"api"}'
# Read Subir_url and Subir_token from the response, then:
curl -X PUT "YOUR_Subir_URL" -H "Authorization: Bearer YOUR_Subir_TOKEN" \
-H "Content-Type: application/PDF" --data-binary @Documento.PDF
# Quote and run with Subir_id; then poll /api/capability-runs/YOUR_RUN_ID.Poll status; cancel cooperatively.
GET /api/capability-runs/{run_id}Read queued, running, retrying, completed, failed, or cancelled state.POST /api/capability-runs/{run_id}/cancelCancel queued work or request cooperative cancellation.GET /api/capability-runs/{run_id}/artifactsList permission-checked artifacts, then follow their Descargar Enlaces.machine_run_status is a safety gate
The canonical values are supported, requires_worker, Plan_only, and describe_only. supported executes in the declared mode. requires_worker preserves the worker-required response until that runtime is ready. Plan_only returns a client Plan without server processing. describe_only blocks quote/run. The legacy value runnable is accepted as supported for backward compatibility. Treat missing or unknown values as describe_only and re-describe before execution.
The same safe flow, as tools.
Connect a streamable HTTP client a https://swarme.io/es/mcp. Begin with tools/list; do not assume a cached list.
swarme_capabilities_Buscarswarme_capability_describeswarme_account_balanceswarme_herramienta_quoteswarme_herramienta_runswarme_herramienta_statusswarme_herramienta_cancelswarme_herramienta_artifactsswarme_Subir_session_CrearInspect machine_run_status after describe. Quote/run only supported, requires_worker, or Plan_only; refuse describe_only, missing, and unknown values. Keep approval boundaries around paid runs and Archivo access.
{
"mcpServers": {
"swarme": {
"type": "streamable-http",
"url": "https://YOUR_SWARME_HOST/mcp",
"Cabeceras": { "Authorization": "Bearer ${SWARME_API_KEY}" }
}
}
}Version and deprecate contracts explicitly.
The contract manifest inventories REST, MCP tools, execution and run states, quote/run and Archivo lifecycles, errors, and scopes. The machine-readable changelog classifies changes as additive, behavioral-risk, or breaking. Unknown manifest elements fail compatibility checks conservatively.
Ejecutar php bin/check-contract-compatibility.php --baseline=BASELINE.json --candidate=CANDIDATE.json locally or in CI. Breaking changes fail unless their stable change IDs appear in an explicit local approvals Archivo.
Deprecation convention
When deprecation is activated for an element, publish manifest deprecated Metadatos and use standard Deprecation, Sunset, and Enlace: <...>; rel=deprecation Cabeceras plus Swarme-Contract-Version. The configured target is at least 90 days' notice when practical. It is a governance target—not an SLA—and urgent Seguridad, legal, abuse-prevention, or uncontrollable upstream changes may require less notice. This increment configures and Documentos the convention only; it does not deprecate or Eliminar any endpoint.
Use any HTTP client.
These examples use environment variables and placeholders only. They contain no credentials. The source distribution also includes copyable, dependency-free examples/rest-agent.php y examples/mcp-agent.php recipes covering Buscar through artifacts or cancellation, with an explicit --approve boundary and optional --file=PATH Subir.
Before integration, run php bin/check-agent-contract.php against bundled versioned fixtures. Supplying --base-url=URL is explicit and performs only read-only public discovery checks. These are reusable starter clients—not a generated SDK or a frozen SDK API.
const baseUrl = process.env.SWARME_BASE_URL ?? "https://YOUR_SWARME_HOST";
const apiKey = process.env.SWARME_API_KEY;
if (!apiKey) throw new Error("Set SWARME_API_KEY");
const request = async (path: string, init: RequestInit = {}) => {
const response = await fetch(`${baseUrl}${path}`, {
...init,
Cabeceras: { Authorization: `Bearer ${apiKey}`, "Content-Type": "application/json", ...init.Cabeceras },
});
if (!response.ok) throw new Error(`${response.status}: ${await response.Texto()}`);
return response.json();
};
const described = await request("/api/capabilities/uuid-generator");
const rawStatus = described.capability?.execution?.machine_run_status;
const machineStatus = rawStatus === "runnable" ? "supported" : rawStatus;
const allowedStatuses = new Set(["supported", "requires_worker", "Plan_only"]);
if (!allowedStatuses.has(machineStatus)) throw new Error("Capability is describe-only; describe again before execution");
const quote = await request("/api/capabilities/uuid-generator/quote", {
method: "POST", body: JSON.stringify({ input: {}, client_type: "api" }),
});
const run = await request("/api/capabilities/uuid-generator/run", {
method: "POST", Cabeceras: { "Idempotency-Key": crypto.randomUUID() },
body: JSON.stringify({ input: {}, client_type: "api", quote_id: quote.quote.quote_id }),
});
const status = await request(`/api/capability-runs/${run.run_id}`);import os, uuid, requests
base_url = os.getenv("SWARME_BASE_URL", "https://YOUR_SWARME_HOST")
api_key = os.environ["SWARME_API_KEY"]
Cabeceras = {"Authorization": f"Bearer {api_key}", "Content-Type": "application/json"}
described = requests.get(f"{base_url}/api/capabilities/uuid-generator", Cabeceras=Cabeceras, timeout=30).json()
raw_status = described.get("capability", {}).get("execution", {}).get("machine_run_status")
machine_status = "supported" if raw_status == "runnable" else raw_status
if machine_status not in {"supported", "requires_worker", "Plan_only"}:
raise RuntimeError("Capability is describe-only; describe again before execution")
quote = requests.post(
f"{base_url}/api/capabilities/uuid-generator/quote",
Cabeceras=Cabeceras, json={"input": {}, "client_type": "api"}, timeout=30,
).json()
run = requests.post(
f"{base_url}/api/capabilities/uuid-generator/run",
Cabeceras={**Cabeceras, "Idempotency-Key": str(uuid.uuid4())},
json={"input": {}, "client_type": "api", "quote_id": quote["quote"]["quote_id"]}, timeout=30,
).json()
status = requests.get(f"{base_url}/api/capability-runs/{run['run_id']}", Cabeceras=Cabeceras, timeout=30).json()