Run any ability by id

The original envelope: the same as POST /v1/abilities/{id}, with the ability named in the body.

POSTRequest

curl -X POST https://substrate.sloelabs.com/abilities/execute \
    -H "Authorization: Bearer $SLOE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{"ability":"capability.discover","input":{}}'

Responses

200400401403429501default

Response 200

The ability ran.

application/json

Example responseGenerated from schema

{
  "ok": true,
  "ability": "ability",
  "duration": 0
}

Response 400

Missing or unknown ability, or input that fails its schema.

application/json

Example responseGenerated from schema

{
  "ok": true,
  "error": "error",
  "ability": "ability",
  "reason": "reason",
  "details": [
    {}
  ],
  "retryAfterMs": 0
}

Response 401

No bearer credential, or one the substrate does not recognise.

application/json

Example responseGenerated from schema

{
  "ok": true,
  "error": "error",
  "ability": "ability",
  "reason": "reason",
  "details": [
    {}
  ],
  "retryAfterMs": 0
}

Response 403

The credential is valid, but its scope does not include this ability.

application/json

Example responseGenerated from schema

{
  "ok": true,
  "error": "error",
  "ability": "ability",
  "reason": "reason",
  "details": [
    {}
  ],
  "retryAfterMs": 0
}

Response 429

Too many requests for this credential. retryAfterMs says when to retry.

application/json

Example responseGenerated from schema

{
  "ok": true,
  "error": "error",
  "ability": "ability",
  "reason": "reason",
  "details": [
    {}
  ],
  "retryAfterMs": 0
}

Response 501

The ability is declared but no handler is wired.

application/json

Example responseGenerated from schema

{
  "ok": true,
  "error": "error",
  "ability": "ability",
  "reason": "reason",
  "details": [
    {}
  ],
  "retryAfterMs": 0
}

Response default

The ability failed. The message is sanitized; a 5xx may be a transient upstream failure.

application/json

Example responseGenerated from schema

{
  "ok": true,
  "error": "error",
  "ability": "ability",
  "reason": "reason",
  "details": [
    {}
  ],
  "retryAfterMs": 0
}

Request body

Required

Yes

Content type

• application/json

• abilitystringrequired
  Allowed values: capability.discover, connection.authorize, connection.get, connection.list, connection.revoke, contact.create, contact.get, contact.list, contact.update, decision.list, decision.record, document.generate, document.summarize, email.render, event.emit, file.store, guide.list, guide.publish, integration.app.connect, integration.app.connections, integration.app.execute, integration.app.toolkits, integration.app.tools, integration.execute, integration.search, key.inspect, key.issue, key.list, key.revoke, key.rotate, lead.create, lead.get, lead.list, lead.update_status, lesson.record, memory.forget, memory.recall, memory.save, memory.search, message.send, message.send_markdown, payment.initiate, payment.list, payment.status, payout.balance, payout.batch, payout.list, payout.send, payout.status, payout.verify_account, plan.create, plan.execute, plan.learn, plan.verify, qa.browser_check, qa.checklist.create, research.verify, sim.generate, sim.list, skill.list, skill.load, task.create, task.get, task.list, task.update_status, trust.preflight, trust.publish, trust.status, vertical.list, vertical.manifest_get, web.browse, web.research, workflow.trigger, workspace.doc.close, workspace.doc.comment, workspace.doc.create, workspace.doc.list, workspace.doc.patch, workspace.doc.read
• inputobjectrequired

  Matches the named ability’s input schema.

• contextCallContextoptional

  Optional call context. The tenant always comes from the credential: tenantId is honoured only by a credential allowed to address sub-tenants, and then nests under the credential’s own tenant.

  Show 3 properties

  • tenantIdstringoptional

    Sub-tenant to act for (sub-tenant credentials only).

  • runIdstringoptional

    The trust run (from trust.preflight) this call executes under.

  • verticalIdstringoptional

    Vertical to attribute created records to.

Returns

Schema shown for 200 · application/json

• result

  The ability’s return value. Its shape depends on the ability.