CyberRXN Docs
APIAPI reference

Balance supplied species or explicitly request optional SynRBL

POST /v1/chemistry/balance

POST /v1/chemistry/balance

API overview · OpenAPI

Authorization

This operation requires a bearer credential. The description defines additional role, scope or first-party-session restrictions; an API key does not grant those permissions by itself.

Request body

PropertyTypeRequiredDetails
reaction_smilesstringyes
method"coefficients" ∣ "synrbl"noDefault: "coefficients".
Full schema: BalanceReactionRequest
{
  "properties": {
    "reaction_smiles": {
      "type": "string",
      "maxLength": 10000,
      "minLength": 1,
      "title": "Reaction Smiles"
    },
    "method": {
      "type": "string",
      "enum": [
        "coefficients",
        "synrbl"
      ],
      "title": "Method",
      "default": "coefficients"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "reaction_smiles"
  ],
  "title": "BalanceReactionRequest"
}

Responses

HTTPDetailsType
200Successful Responseapplication/json: ReactionBalanceResult
401Unauthorizedapplication/problem+json: ProblemDetails
402Payment Requiredapplication/problem+json: ProblemDetails
403Forbiddenapplication/problem+json: ProblemDetails
408Request Timeoutapplication/problem+json: ProblemDetails
413Request Entity Too Largeapplication/problem+json: ProblemDetails
422Unprocessable Entityapplication/problem+json: ProblemDetails
429Too Many Requestsapplication/problem+json: ProblemDetails
502Bad Gatewayapplication/problem+json: ProblemDetails
503Service Unavailableapplication/problem+json: ProblemDetails

Response: ReactionBalanceResult

PropertyTypeRequiredDetails
method"coefficients" ∣ "synrbl"yes
status"invalid" ∣ "already_balanced" ∣ "balanced" ∣ "unsolved" ∣ "ambiguous" ∣ "limit_exceeded"yes
solvedbooleanyes
original_reaction_smilesstringyes
balanced_reaction_smilesstring ∣ nullyes
reactant_coefficientsReactionCoefficient[]yes
product_coefficientsReactionCoefficient[]yes
imputed_speciesbooleanyes
imputed_reactantsstring ∣ nullno
imputed_productsstring ∣ nullno
model_diagnosticsobject ∣ nullno
validationReactionValidationResultyes
limitationsstring[]yes
Full schema
{
  "properties": {
    "method": {
      "type": "string",
      "enum": [
        "coefficients",
        "synrbl"
      ],
      "title": "Method"
    },
    "status": {
      "type": "string",
      "enum": [
        "invalid",
        "already_balanced",
        "balanced",
        "unsolved",
        "ambiguous",
        "limit_exceeded"
      ],
      "title": "Status"
    },
    "solved": {
      "type": "boolean",
      "title": "Solved"
    },
    "original_reaction_smiles": {
      "type": "string",
      "title": "Original Reaction Smiles"
    },
    "balanced_reaction_smiles": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Balanced Reaction Smiles"
    },
    "reactant_coefficients": {
      "items": {
        "$ref": "#/components/schemas/ReactionCoefficient"
      },
      "type": "array",
      "title": "Reactant Coefficients"
    },
    "product_coefficients": {
      "items": {
        "$ref": "#/components/schemas/ReactionCoefficient"
      },
      "type": "array",
      "title": "Product Coefficients"
    },
    "imputed_species": {
      "type": "boolean",
      "title": "Imputed Species"
    },
    "imputed_reactants": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Imputed Reactants"
    },
    "imputed_products": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Imputed Products"
    },
    "model_diagnostics": {
      "anyOf": [
        {
          "additionalProperties": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Model Diagnostics"
    },
    "validation": {
      "$ref": "#/components/schemas/ReactionValidationResult"
    },
    "limitations": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Limitations"
    }
  },
  "additionalProperties": true,
  "type": "object",
  "required": [
    "method",
    "status",
    "solved",
    "original_reaction_smiles",
    "balanced_reaction_smiles",
    "reactant_coefficients",
    "product_coefficients",
    "imputed_species",
    "validation",
    "limitations"
  ],
  "title": "ReactionBalanceResult"
}

This page is generated from OpenAPI; examples are schemas, not a fabricated successful response.

Usage and billing · Structured errors

On this page