CyberRXN Docs
APIAPI reference

One observation with provenance and checks

GET /v1/observations/{observation_id}

GET /v1/observations/{observation_id}

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.

Parameters

PropertyTypeRequiredDetails
observation_id (path)stringyes
include_raw (query)booleanno

Request body

No request body.

Responses

HTTPDetailsType
200Successful Responseapplication/json: ObservationDetail
401Unauthorizedapplication/problem+json: ProblemDetails
402Payment Requiredapplication/problem+json: ProblemDetails
403Forbiddenapplication/problem+json: ProblemDetails
404Not Foundapplication/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: ObservationDetail

PropertyTypeRequiredDetails
dataset_revisionstring ∣ nullnoImmutable corpus snapshot revision.
record_digeststring ∣ nullnoSHA-256 of source-record and normalized scientific semantics; stable across corpus appends.
observation_idstringyes
reaction_idstring ∣ nullyes
reaction_smilesstring ∣ nullyes
conditionsConditionsyes
evidenceEvidenceyes
validationValidationyes
balancingBalancingyes
original_reaction_smilesstring ∣ nullyes
rebalanced_reaction_smilesstring ∣ nullyes
imputed_componentsImputedComponentsyes
sourceSourceyes
paragraph_textstring ∣ nullyes
raw_metadataobject ∣ nullnoOnly with include_raw=true.
Full schema
{
  "properties": {
    "dataset_revision": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Dataset Revision",
      "description": "Immutable corpus snapshot revision."
    },
    "record_digest": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^[a-f0-9]{64}$"
        },
        {
          "type": "null"
        }
      ],
      "title": "Record Digest",
      "description": "SHA-256 of source-record and normalized scientific semantics; stable across corpus appends."
    },
    "observation_id": {
      "type": "string",
      "title": "Observation Id"
    },
    "reaction_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Reaction Id"
    },
    "reaction_smiles": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Reaction Smiles"
    },
    "conditions": {
      "$ref": "#/components/schemas/Conditions"
    },
    "evidence": {
      "$ref": "#/components/schemas/Evidence"
    },
    "validation": {
      "$ref": "#/components/schemas/Validation"
    },
    "balancing": {
      "$ref": "#/components/schemas/Balancing"
    },
    "original_reaction_smiles": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Original Reaction Smiles"
    },
    "rebalanced_reaction_smiles": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Rebalanced Reaction Smiles"
    },
    "imputed_components": {
      "$ref": "#/components/schemas/ImputedComponents"
    },
    "source": {
      "$ref": "#/components/schemas/Source"
    },
    "paragraph_text": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Paragraph Text"
    },
    "raw_metadata": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Raw Metadata",
      "description": "Only with include_raw=true."
    }
  },
  "additionalProperties": true,
  "type": "object",
  "required": [
    "observation_id",
    "reaction_id",
    "reaction_smiles",
    "conditions",
    "evidence",
    "validation",
    "balancing",
    "original_reaction_smiles",
    "rebalanced_reaction_smiles",
    "imputed_components",
    "source",
    "paragraph_text"
  ],
  "title": "ObservationDetail"
}

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

Usage and billing · Structured errors

On this page