Skip to main content
POST
Search for homologous protein sequences in a batch

Authorizations

Authorization
string
header
required

A Rafflesia API key, sent as Authorization: Bearer <key>.

Headers

Idempotency-Key
string

Optional retry identity for the complete all-or-nothing batch. Reuse the same key only with the same request.

Body

application/json
database
string
required

Database id or slug from homology.databases.list. Exactly one of database or database_release_id is required.

Required string length: 1 - 256
queries
object[]
required

An ordered batch of 1 to 16 typed biological queries sharing every search control.

Required array length: 1 - 16 elements
database_release_id
string

Exact immutable release id. Exactly one of database or database_release_id is required.

Required string length: 1 - 256
filter
object

Optional exact metadata predicate applied before candidate generation.

guarantee
enum<string>
default:approximate

Minimum search guarantee. Approximate permits a qualified approximate policy or a stronger exhaustive fallback; exhaustive requires the release's exhaustive reference policy.

Available options:
approximate,
exhaustive
include
enum<string>[]

Scientific result representations to return. Pairwise alignment is included by default. Pass an empty array for candidate measurements only.

Maximum array length: 1
Available options:
alignment
include_attributes
enum<string>[] | null

Optional target attributes to project. The current Tomato catalog can project record_id; unsupported attributes are rejected instead of fabricated.

Maximum array length: 1
Available options:
record_id
limit
integer<int64>
default:25

Maximum number of ranked results to return per query. queries count multiplied by limit must fit the include-sensitive aggregate batch cap.

Required range: 1 <= x <= 10000
max_billable_units
integer<int64>

Optional hard ceiling on deterministic billable work across the complete batch. The batch fails before exceeding it.

Required range: x >= 1
significance
enum<string>
default:if_available

Whether database-aware significance is omitted, included when a compatible calibration exists, or required for the request to succeed.

Available options:
not_requested,
if_available,
required

Response

OK

performance
object
required
request_id
string
required
responses
object[]
required
Required array length: 1 - 16 elements
result_sha256
string
required
usage
object
required
warnings
object[] | null
required