CyberRXN Docs
APIAPI reference

Observations where a molecule takes part

POST /v1/molecules/reactions

POST /v1/molecules/reactions

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
smilesstringyesOne molecule (no dots).
role"reactant" ∣ "product" ∣ "agent" ∣ nullno
limitintegernoMaximum records, from 1 to 100. Default: 10.
offsetintegernoZero-based pagination offset. Default: 0.
Full schema: MoleculeReactionsRequest
{
  "properties": {
    "smiles": {
      "type": "string",
      "maxLength": 10000,
      "minLength": 1,
      "title": "Smiles",
      "description": "One molecule (no dots)."
    },
    "role": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "reactant",
            "product",
            "agent"
          ]
        },
        {
          "type": "null"
        }
      ],
      "title": "Role"
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "title": "Limit",
      "description": "Maximum records, from 1 to 100.",
      "default": 10
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "title": "Offset",
      "description": "Zero-based pagination offset.",
      "default": 0
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "smiles"
  ],
  "title": "MoleculeReactionsRequest"
}

Responses

HTTPDetailsType
200Successful Responseapplication/json: ObservationPage
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: ObservationPage

PropertyTypeRequiredDetails
itemsObservation[]yes
limitintegeryes
offsetintegeryes
has_morebooleanyes
next_offsetinteger ∣ nullyes
Full schema
{
  "properties": {
    "items": {
      "items": {
        "$ref": "#/components/schemas/Observation"
      },
      "type": "array",
      "title": "Items"
    },
    "limit": {
      "type": "integer",
      "title": "Limit"
    },
    "offset": {
      "type": "integer",
      "title": "Offset"
    },
    "has_more": {
      "type": "boolean",
      "title": "Has More"
    },
    "next_offset": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Next Offset"
    }
  },
  "additionalProperties": true,
  "type": "object",
  "required": [
    "items",
    "limit",
    "offset",
    "has_more",
    "next_offset"
  ],
  "title": "ObservationPage"
}

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

Usage and billing · Structured errors

On this page