CyberRXN Docs
APIAPI reference

Reactions with structurally similar products

POST /v1/products/similar

POST /v1/products/similar

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
smilesstringyesProduct set (SMILES) to compare by Morgan/Tanimoto similarity.
thresholdnumbernoDefault: 0.5.
limitintegernoMaximum records, from 1 to 100. Default: 10.
validated_onlybooleannoDefault: true.
Full schema: SimilarProductsRequest
{
  "properties": {
    "smiles": {
      "type": "string",
      "maxLength": 10000,
      "minLength": 1,
      "title": "Smiles",
      "description": "Product set (SMILES) to compare by Morgan/Tanimoto similarity."
    },
    "threshold": {
      "type": "number",
      "maximum": 1,
      "minimum": 0.05,
      "title": "Threshold",
      "default": 0.5
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "title": "Limit",
      "description": "Maximum records, from 1 to 100.",
      "default": 10
    },
    "validated_only": {
      "type": "boolean",
      "title": "Validated Only",
      "default": true
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "smiles"
  ],
  "title": "SimilarProductsRequest"
}

Responses

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

PropertyTypeRequiredDetails
itemsSimilarProduct[]yes
metricstringyes
fingerprintstringyes
thresholdnumberyes
scanned_candidatesintegeryes
search_is_exact_over_fingerprintsbooleanyes
is_reaction_predictionbooleanyes
limitationstringyes
Full schema
{
  "properties": {
    "items": {
      "items": {
        "$ref": "#/components/schemas/SimilarProduct"
      },
      "type": "array",
      "title": "Items"
    },
    "metric": {
      "type": "string",
      "const": "Tanimoto",
      "title": "Metric"
    },
    "fingerprint": {
      "type": "string",
      "title": "Fingerprint"
    },
    "threshold": {
      "type": "number",
      "title": "Threshold"
    },
    "scanned_candidates": {
      "type": "integer",
      "title": "Scanned Candidates"
    },
    "search_is_exact_over_fingerprints": {
      "type": "boolean",
      "title": "Search Is Exact Over Fingerprints"
    },
    "is_reaction_prediction": {
      "type": "boolean",
      "title": "Is Reaction Prediction"
    },
    "limitation": {
      "type": "string",
      "title": "Limitation"
    }
  },
  "additionalProperties": true,
  "type": "object",
  "required": [
    "items",
    "metric",
    "fingerprint",
    "threshold",
    "scanned_candidates",
    "search_is_exact_over_fingerprints",
    "is_reaction_prediction",
    "limitation"
  ],
  "title": "SimilarProductsResult"
}

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

Usage and billing · Structured errors

On this page