Skip to main content

BatchExecuteResult

Response body for POST /execute/batch.

results — one entry per input entity, in input order. total — total entities in the request. failed — count of entities with a non-null error.

results object[]required
  • Array [
    • entityEntity (string)required
    result object
    anyOf
    value objectrequired
    anyOf
    number
    typeConceptOutputType (string)required

    Declared output type of a concept. Matches the ConceptResult.type wire values.

    Determines which Python type result.value carries: float → float boolean → bool categorical → str (a label from the declared label set)

    Possible values: [float, boolean, categorical]

    entityEntity (string)required
    versionVersion (string)required
    deterministicDeterministic (boolean)required
    timestamp object
    anyOf
    string
    explanation object
    anyOf
    output objectrequired
    anyOf
    number
    contributions object
    property name*number
    nodes object[]
  • Array [
    • node_idNode Id (string)required
    opOp (string)required
    inputsobjectrequired
    paramsobjectrequired
    output_value objectrequired
    anyOf
    number
    output_typeOutput Type (string)required
  • ]
    • traceobject[]
    error object
    anyOf
    error objectrequired

    The inner error object serialised inside ErrorResponse.

    This is the exact shape the API spec requires: { "type": "...", "message": "...", "location": null, "suggestion": null }

    Callers must branch on type, never on message.

    typeErrorType (string)required

    Canonical error type identifiers. The string value is the wire value.

    Rules (from API spec):

    • Callers must branch on .type, never on .message.
    • Message text is for humans; type is for machines.
    • The enum spelling is the ground truth for YAML, HTTP, and Python alike. In particular: z_score (not zscore), not_found (not 404), conflict (not 409).

    Possible values: [syntax_error, type_error, semantic_error, reference_error, parameter_error, graph_error, execution_error, execution_timeout, auth_error, not_found, conflict, rate_limit_exceeded, bounds_exceeded, action_binding_failed]

    messageMessage (string)required
    location object
    anyOf
    string
    suggestion object
    anyOf
    string
  • ]
    • totalTotal (integer)required
    failedFailed (integer)required
    BatchExecuteResult
    {
      "results": [
        {
          "entity": "string",
          "result": {
            "value": 0,
            "type": "float",
            "entity": "string",
            "version": "string",
            "deterministic": true,
            "timestamp": "string",
            "explanation": {
              "output": 0,
              "contributions": {},
              "nodes": [
                {
                  "node_id": "string",
                  "op": "string",
                  "inputs": {},
                  "params": {},
                  "output_value": 0,
                  "output_type": "string"
                }
              ],
              "trace": [
                {}
              ]
            }
          },
          "error": {
            "error": {
              "type": "syntax_error",
              "message": "string",
              "location": "string",
              "suggestion": "string"
            }
          }
        }
      ],
      "total": 0,
      "failed": 0
    }