Skip to main content

CapabilityResult

The outcome of one capability call.

Exactly one of result/error is set: ok=True carries the handler's result payload (validated against the descriptor's output_schema when one is published); ok=False carries a typed :class:CapabilityError.

Attributes: call_id: Echoed correlation id. ok: Whether the call succeeded. result: The result payload on success, else None. error: The typed failure on error, else None.

call_idCall Id (string)required
okOk (boolean)required
result object
anyOf
object
error object
anyOf
codeCode (string)required

Possible values: [not_found, version_mismatch, revision_mismatch, invalid_payload, invalid_result, payload_too_large, overloaded, timeout, provider_error, unreachable]

messageMessage (string)required
CapabilityResult
{
"call_id": "string",
"ok": true,
"result": {},
"error": {
"code": "not_found",
"message": "string"
}
}