Complete REST API reference for Jarvis SDK. Base URL: https://jarvissdk.com
All authenticated endpoints require the x-api-key header. See Authentication for details. Also available as OpenAPI 3.1 spec.
/api/v1/modulesList all modules in the catalog. Supports pagination, filtering by category, and sorting.
?limit=20&offset=0&category=data-processing&sort=trust_score&order=desc
{
"modules": [
{
"name": "text-toolkit",
"display_name": "Text Toolkit",
"description": "Text processing utilities",
"category": "data-processing",
"version": 1,
"trust_score": 95,
"runtime_type": "builtin",
"action_count": 12,
"total_executions": 45230
}
],
"total": 695,
"limit": 20,
"offset": 0
}/api/v1/catalog/searchSearch modules by capability using natural language or keywords.
?q=hash+sha256&limit=10
{
"results": [
{
"name": "hash-toolkit",
"display_name": "Hash Toolkit",
"trust_score": 92,
"relevance": 0.95,
"actions": ["sha256", "md5", "sha512", "hmac"]
}
],
"query": "hash sha256",
"total": 3
}/api/v1/modules/{name}Get detailed information about a specific module including all actions and schemas.
{
"name": "text-toolkit",
"display_name": "Text Toolkit",
"description": "Comprehensive text processing utilities",
"category": "data-processing",
"version": 1,
"trust_score": 95,
"trust_tier": "gold",
"runtime_type": "builtin",
"actions": [
{
"name": "word_count",
"description": "Count words, characters, and sentences",
"input_schema": {
"type": "object",
"properties": { "text": { "type": "string" } },
"required": ["text"]
}
}
],
"pricing": { "tier": "free", "price_per_call": 0 }
}/api/v1/modules/{name}/executeExecute a specific action on a module. Returns the result with trace ID and timing.
{
"action": "word_count",
"input": { "text": "Hello from Jarvis SDK" }
}{
"success": true,
"trace_id": "tr_a1b2c3d4",
"duration_ms": 12,
"result": {
"word_count": 4,
"character_count": 20,
"sentence_count": 1
}
}/api/v1/chainChain multiple module actions together. Output from step N is available to step N+1 via {{prev}} template.
{
"steps": [
{
"module": "text-toolkit",
"action": "slug_generate",
"input": { "text": "My Blog Post Title" }
},
{
"module": "hash-toolkit",
"action": "sha256_hash",
"input": { "data": "{{prev.slug}}" }
}
]
}{
"success": true,
"trace_id": "tr_chain_xyz",
"steps": [
{ "module": "text-toolkit", "action": "slug_generate", "result": { "slug": "my-blog-post-title" } },
{ "module": "hash-toolkit", "action": "sha256_hash", "result": { "hash": "a1b2c3..." } }
],
"final_result": { "hash": "a1b2c3..." }
}/api/v1/batchExecute multiple module actions in parallel. All steps run concurrently.
{
"operations": [
{ "module": "text-toolkit", "action": "word_count", "input": { "text": "Hello" } },
{ "module": "hash-toolkit", "action": "md5_hash", "input": { "data": "Hello" } }
]
}{
"success": true,
"results": [
{ "success": true, "result": { "word_count": 1 } },
{ "success": true, "result": { "hash": "8b1a9953c..." } }
],
"duration_ms": 18
}/api/v1/agent/armSelf-equip: Describe your mission in natural language and receive a curated toolkit of recommended modules.
{
"mission": "I need to process CSV files, extract data, and generate markdown reports"
}{
"toolkit": [
{ "name": "csv-toolkit", "reason": "Parse and transform CSV data" },
{ "name": "text-toolkit", "reason": "Text processing and formatting" },
{ "name": "markdown-toolkit", "reason": "Generate markdown output" }
],
"mission_understood": "Data pipeline: CSV input -> processing -> markdown report"
}/api/v1/agent/chatNatural language interface. Describe what you need and the agent routes to the right module and action.
{
"message": "hash the string 'hello world' with SHA-256"
}{
"response": "Here's the SHA-256 hash of 'hello world':",
"execution": {
"module": "hash-toolkit",
"action": "sha256_hash",
"result": { "hash": "b94d27b9..." }
}
}/api/v1/intel/recommendGet personalized module recommendations based on your usage patterns and context.
?context=csv+processing&limit=5
{
"recommendations": [
{
"module": "csv-toolkit",
"reason": "Matches your query and has 95 trust score",
"trust_score": 95,
"category": "data-processing"
}
]
}/api/v1/trust/{name}Get the trust score and breakdown for a specific module.
{
"module": "text-toolkit",
"trust_score": 95,
"trust_tier": "gold",
"dimensions": {
"reliability": 98,
"performance": 92,
"security": 96,
"documentation": 90,
"community": 94
},
"certification_status": "certified",
"last_recertified": "2026-03-01T00:00:00Z"
}/api/v1/trust/leaderboardGet the top-rated modules ranked by trust score.
?limit=10&category=all
{
"leaderboard": [
{ "rank": 1, "name": "text-toolkit", "trust_score": 95, "tier": "gold" },
{ "rank": 2, "name": "hash-toolkit", "trust_score": 92, "tier": "gold" }
]
}/api/v1/billing/usageGet current billing period usage, limits, and overage information.
{
"plan": "pro",
"period": { "start": "2026-03-01", "end": "2026-03-31" },
"usage": {
"executions": 12450,
"limit": 50000,
"percentage": 24.9
},
"overage": { "rate": 0.001, "overage_executions": 0, "overage_cost": 0 }
}/api/v1/healthPublicPlatform health check. Returns service status and version. No authentication required.
{
"status": "healthy",
"version": "2.4.0",
"services": {
"api": "operational",
"database": "operational",
"billing": "operational"
},
"timestamp": "2026-03-04T12:00:00Z"
}/api/v1/health/dogfoodPublicLive smoke test that executes real module actions and reports results.
{
"status": "healthy",
"tests": [
{ "module": "text-toolkit", "action": "word_count", "passed": true, "ms": 8 },
{ "module": "hash-toolkit", "action": "md5_hash", "passed": true, "ms": 5 }
],
"passed": 2,
"failed": 0
}/api/mcpMCP JSON-RPC 2.0 server endpoint. Supports tools/list and tools/call methods.
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/list"
}{
"jsonrpc": "2.0",
"id": 1,
"result": {
"tools": [
{ "name": "jarvis_sdk_search", "description": "Search modules", "inputSchema": {...} },
{ "name": "jarvis_sdk_run", "description": "Execute a module action", "inputSchema": {...} }
]
}
}/.well-known/agent.jsonPublicA2A Agent Card. Describes Jarvis SDK's capabilities for agent-to-agent discovery.
{
"name": "Jarvis SDK",
"url": "https://jarvissdk.com",
"version": "1.0.0",
"protocol_version": "0.2.0",
"skills": [
{ "id": "module-discovery", "name": "Module Discovery" },
{ "id": "module-execution", "name": "Module Execution" }
],
"authentication": { "schemes": ["apiKey"] }
}/api/llms.txtPublicLLM-friendly plain-text documentation. Optimized for context windows.
/api/openapi.jsonPublicOpenAPI 3.1.0 specification. Machine-readable API description.
All error responses follow this format:
{
"error": "Module not found",
"code": "MODULE_NOT_FOUND",
"status": 404,
"request_id": "req_a1b2c3"
}| Status | Meaning |
|---|---|
| 200 | Success |
| 201 | Created (new resource) |
| 400 | Bad request (invalid parameters) |
| 401 | Unauthorized (missing/invalid API key) |
| 403 | Forbidden (insufficient scope) |
| 404 | Not found |
| 429 | Rate limit exceeded |
| 500 | Internal server error |