Skip to content

Manifests

A manifest is another way to define remote data resources to import into SolveBio. Manifests contain one or more objects containing a URL or an object_id. Manifests can include the following parameters:

Parameters

Property Value Description
url string A publicly accessible URL pointing to a file to import into SolveBio. You must pass a URL or an object_id.
object_id long The ID of an existing object on SolveBio. You must pass an object_id or a URL.
name string (optional) The name of the file. If not passed, SolveBio will take it from the URL or object.
format string (optional) The file format of the file. If not passed, SolveBio will take it from the URL or object.
md5 string (optional) The md5 hash of the file contents. If passed, SolveBio will validate the file after downloading and fail if mismatched.
entity_params object (optional) Configuration parameters for entity detection.
reader_params object (optional) Configuration parameters for readers.
validation_params object (optional) Configuration parameters for validation.

Example Manifest

1
2
3
4
5
6
7
8
9
{
    "files": [{
        "url": "https://example.com/file.json.gz",
        "name": "file.json.gz",
        "format": "json",
        "md5": "d41d8cd98f00b204e9800998ecf8427e",
        "validation_params": {"disable": True}
    }]
}

Formats

The following formats are allowed

Format Extension
vcf .vcf
jsonl .json
csv .csv
tsv .tsv, .txt, .maf
xml .xml
gtf .gtf
gff3 .gff3