Queue a Batch Search on a Namespace

This endpoint queues up an alignment search for a query sequence against a specific namespace, and returns a ticket number that can be used to retrieve the results upon completion. You can use a batch search for a query that you expect to take a long time.

HTTP Request

POST http://example.com/namespace/<ID>/batch

URL Parameters

Parameter Description
ID The unique identifier for the namespace to search for alignments

Query Parameters

Parameter Description
file A FASTA file containing query sequences for which alignments are sought in the given namespace
sequence A string containing a query sequence (as an alternative to file)
eVal The maximum E-Value threshold for the search (default: none)
maxHits The number of results after which the search immediately returns (default: no max)

Response

14

Examples

curl -F file=@sequence_fasta_file http://example.com/namespace/<ID>/batch

The above command returns a ticket number that can be used to retrieve results upon completion.

curl -F sequence=sequence_fasta_file -F eVal=1e-5 http://example.com/namespace/<ID>/search

The above command returns a ticket number for retrieving the results of the search for the given sequence (provided as a string), with a maximum E-value of 1e-5.