Skip to content

API Documentation

Milot Mirdita edited this page Apr 15, 2021 · 1 revision

MMseqs2 Server API documentation version v1

https://search.mmseqs.com/api


/databases

Provides a list of available search databases, including all parameters needed for the frontend.

/databases

  • get:

/databases/order

Reorders the databases. Only available if server was started with "-server.dbmanagment true" parameter.

  • post:

/database

Adds or removes a search database for processing. Only available if server was started with "-server.dbmanagment true" parameter.

/database

  • post:
  • delete:

/ticket

Submits a new job to the queue and gets a ticket referencing this job. Ticket is needed for all further api calls regarding this job.

/ticket

  • post:

/ticket/{ticket}

Gets the status of a ticket

  • get:

/ticket/type/{ticket}

Gets the type of the ticket

  • get:

/tickets

Gets the status of multiple tickets

/tickets

  • post:

/result

/result/{ticket}/{entry}

Gets the alignment results for query number entry of the ticket.

  • get:

/result/download/{ticket}

Downloads all alignment results in a BLAST-tab compatible format for the specified ticket.

  • get:

/result/queries/{ticket}/{limit}/{page}

Gets a paginated list of queries belonging to a search job.

  • get: