Annotate¶
Run a set of expressions on a list of records in real time.
HTTP Request
POST https://api.solvebio.com/v1/annotate
Parameters
This request does not accept URL parameters.
Authorization
This request requires an authorized user.
Request Body
In the request body, provide the following properties:
| Property | Value | Description |
|---|---|---|
| fields | DatasetField | A list of dataset field objects. |
| include_errors | boolean | If True, a new field (_errors) will be added to each record containing expression evaluation errors (default: True). |
| records | objects | An arbitrary list of records. |
| pre_annotation_expression | string | An arbitrary expression that will be applied before the annotation, e.g. 'explode(record, fields=["mutations"])' |
| post_annotation_expression | string | An arbitrary expression that will be applied after the annotation, e.g. 'melt(record, fields=["gene", "chromosome"])' |
Response
The response contains a list of annotated records and an object containing the number of records with errors and the number of fields with errors.