SpaceM1 API User Guide

Getting started

Get search metadata

Request

GET

http://localhost:2222/api/v2/batch-search/{id}

#{id}

string

required

ID of the search.

Example

curl http://localhost:2222/api/v2/batch-search/{id} \
  -H "Authorization: ApiToken-v1 YOUR_API_TOKEN"

Response

Body application/json

#id

string

Search ID.

#name

string

Search name.

Default value: part of the generated search ID if not specified in request

#size

integer

Number of targets specified in the search request.

#inputParams

dictionary

parameters specified in the search request.

#searchParams

dictionary

Final parameters used to create the search request. They are a combination of inputParams and presetParams.

#priority

integer

priority specified in the search request or its default value.

#createdAt

string

Search created date and time as an ISO 8601 formatted string.

#source

'WEB' | 'API_V2'

Origin of the search request.

#presetParams

dictionary

Parameters specified by chosen preset in the search request.

Default value: "Default for search" preset configured in the RetroScore interface

#presetName

string

Name of the preset applied to the search request.

Example

{
  "createdAt": "2023-04-07T10:13:29.932Z",
  "id": "bcd34242-70c3-46f0-819d-e261eaf876f0",
  "name": "my-search",
  "size": 3,
  "inputParams": {
    "availability_tier": 3,
    "length": "short",
    "model": "metro",
    "synthesis_scale": "millimolar",
    "reaction_confidence_threshold": "high",
    "min_reference_count": 10
  },
  "searchParams": {
    "detail_level": "best_path",
    "presets": {
      "model": "metro",
      "length": "short",
      "datasets": [{ "id": "emolecules" }],
      "synthesis_scale": "millimolar",
      "availability_tier": 3,
      "reaction_confidence_threshold": "high",
      "min_reference_count": 10
    }
  },
  "presetParams": {
    "availability_tier": 3,
    "datasets": [{ "id": "emolecules" }],
    "model": "metro",
    "length": "regular",
    "synthesis_scale": "millimolar",
    "reaction_confidence_threshold": "high",
    "min_reference_count": 10
  },
  "presetName": "base-parameters",
  "priority": 3,
  "source": "API_V2"
}