Find Input References Endpoint

Find all input references from a protocol.

This endpoint extracts all input references of the form input[“name”] from the provided protocol. The protocol can be provided as a dictionary (JSON), YAML string, or Protocol object serialized as dict.

Parameters

body : FindInputReferencesRequest Request containing the protocol to analyze

Returns

list[str] List of input reference names found in the protocol

Raises

HTTPException If protocol parsing fails or input references cannot be extracted

Find Input References Endpoint

cURL

curl --request POST \
  --url https://api.ionworks.com/protocols/input_references \
  --header 'Content-Type: application/json' \
  --data '{
  "protocol": {}
}'

200

[
  "<string>"
]

Body

application/json

Request body for finding input references in a protocol.

protocol · Protocol · object string any[] · required

Protocol as a dictionary (JSON), list, or string. Can be a protocol dict, list of steps, YAML string, or Protocol object serialized.

Response

200

application/json

Successful Response