Search for homologous protein sequences

curl --request POST \
  --url https://api.rafflesia.ai/v1/homology \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "database": "<string>",
  "sequence": "<string>",
  "database_release_id": "<string>",
  "filter": {
    "filters": [
      "<unknown>"
    ],
    "op": "and",
    "field": "<string>",
    "filter": "<unknown>",
    "value": "<string>",
    "values": [
      "<string>"
    ]
  },
  "guarantee": "approximate",
  "include": [
    "alignment"
  ],
  "include_attributes": [
    "record_id"
  ],
  "limit": 25,
  "max_billable_units": 2,
  "significance": "not_requested"
}
'

import requests

url = "https://api.rafflesia.ai/v1/homology"

payload = {
    "database": "<string>",
    "sequence": "<string>",
    "database_release_id": "<string>",
    "filter": {
        "filters": ["<unknown>"],
        "op": "and",
        "field": "<string>",
        "filter": "<unknown>",
        "value": "<string>",
        "values": ["<string>"]
    },
    "guarantee": "approximate",
    "include": ["alignment"],
    "include_attributes": ["record_id"],
    "limit": 25,
    "max_billable_units": 2,
    "significance": "not_requested"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    database: '<string>',
    sequence: '<string>',
    database_release_id: '<string>',
    filter: {
      filters: ['<unknown>'],
      op: 'and',
      field: '<string>',
      filter: '<unknown>',
      value: '<string>',
      values: ['<string>']
    },
    guarantee: 'approximate',
    include: ['alignment'],
    include_attributes: ['record_id'],
    limit: 25,
    max_billable_units: 2,
    significance: 'not_requested'
  })
};

fetch('https://api.rafflesia.ai/v1/homology', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.rafflesia.ai/v1/homology",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'database' => '<string>',
    'sequence' => '<string>',
    'database_release_id' => '<string>',
    'filter' => [
        'filters' => [
                '<unknown>'
        ],
        'op' => 'and',
        'field' => '<string>',
        'filter' => '<unknown>',
        'value' => '<string>',
        'values' => [
                '<string>'
        ]
    ],
    'guarantee' => 'approximate',
    'include' => [
        'alignment'
    ],
    'include_attributes' => [
        'record_id'
    ],
    'limit' => 25,
    'max_billable_units' => 2,
    'significance' => 'not_requested'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rafflesia.ai/v1/homology"

	payload := strings.NewReader("{\n  \"database\": \"<string>\",\n  \"sequence\": \"<string>\",\n  \"database_release_id\": \"<string>\",\n  \"filter\": {\n    \"filters\": [\n      \"<unknown>\"\n    ],\n    \"op\": \"and\",\n    \"field\": \"<string>\",\n    \"filter\": \"<unknown>\",\n    \"value\": \"<string>\",\n    \"values\": [\n      \"<string>\"\n    ]\n  },\n  \"guarantee\": \"approximate\",\n  \"include\": [\n    \"alignment\"\n  ],\n  \"include_attributes\": [\n    \"record_id\"\n  ],\n  \"limit\": 25,\n  \"max_billable_units\": 2,\n  \"significance\": \"not_requested\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.rafflesia.ai/v1/homology")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"database\": \"<string>\",\n  \"sequence\": \"<string>\",\n  \"database_release_id\": \"<string>\",\n  \"filter\": {\n    \"filters\": [\n      \"<unknown>\"\n    ],\n    \"op\": \"and\",\n    \"field\": \"<string>\",\n    \"filter\": \"<unknown>\",\n    \"value\": \"<string>\",\n    \"values\": [\n      \"<string>\"\n    ]\n  },\n  \"guarantee\": \"approximate\",\n  \"include\": [\n    \"alignment\"\n  ],\n  \"include_attributes\": [\n    \"record_id\"\n  ],\n  \"limit\": 25,\n  \"max_billable_units\": 2,\n  \"significance\": \"not_requested\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.rafflesia.ai/v1/homology")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"database\": \"<string>\",\n  \"sequence\": \"<string>\",\n  \"database_release_id\": \"<string>\",\n  \"filter\": {\n    \"filters\": [\n      \"<unknown>\"\n    ],\n    \"op\": \"and\",\n    \"field\": \"<string>\",\n    \"filter\": \"<unknown>\",\n    \"value\": \"<string>\",\n    \"values\": [\n      \"<string>\"\n    ]\n  },\n  \"guarantee\": \"approximate\",\n  \"include\": [\n    \"alignment\"\n  ],\n  \"include_attributes\": [\n    \"record_id\"\n  ],\n  \"limit\": 25,\n  \"max_billable_units\": 2,\n  \"significance\": \"not_requested\"\n}"

response = http.request(request)
puts response.read_body

{
  "ok": true,
  "provenance": {
    "created_at": "<string>",
    "operation": "<string>",
    "request_id": "<string>",
    "server_version": "<string>",
    "cache_hit": true,
    "database_snapshots": [
      {
        "name": "<string>",
        "version": "<string>",
        "digest": "<string>",
        "kind": "<string>"
      }
    ],
    "generated_object_ids": [
      "<string>"
    ],
    "input_hash": "<string>",
    "parameters_hash": "<string>",
    "tool_versions": [
      {
        "name": "<string>",
        "version": "<string>",
        "path": "<string>"
      }
    ]
  },
  "warnings": [
    {
      "code": "<string>",
      "message": "<string>",
      "details": {}
    }
  ],
  "$schema": "<string>",
  "data": {
    "database": {
      "corpus_snapshot_id": "<string>",
      "id": "<string>",
      "release_id": "<string>",
      "searched_residue_count": 1,
      "searched_target_count": 1,
      "slug": "<string>",
      "canonical_filter_sha256": "<string>"
    },
    "is_result_limit_reached": true,
    "method": {
      "engine": "<string>",
      "is_deterministic": true,
      "is_exhaustive": true,
      "search_policy_id": "<string>",
      "semantic_profile_id": "<string>",
      "calibration_id": "<string>",
      "engine_release": "<string>"
    },
    "query": {
      "normalization_id": "<string>",
      "normalized_length": 123,
      "sha256": "<string>"
    },
    "result_sha256": "<string>",
    "results": [
      {
        "maxsim": {
          "bidirectional": 123,
          "query_to_target": 123,
          "target_to_query": 123
        },
        "rank": 123,
        "target": {
          "id": "<string>",
          "attributes": {}
        },
        "affine": {
          "normalized_score": 123,
          "raw_score": 123
        },
        "alignment": {
          "aligned_residue_count": 123,
          "cigar": "<string>",
          "cigar_dialect": "<string>",
          "coordinate_system": "<string>",
          "gap_opening_count": 123,
          "gap_residue_count": 123,
          "identical_residue_count": 123,
          "query_coverage_ratio": 123,
          "query_end": 123,
          "query_length": 123,
          "query_start": 123,
          "target_coverage_ratio": 123,
          "target_end": 123,
          "target_length": 123,
          "target_start": 123
        },
        "significance": {
          "calibration_id": "<string>",
          "calibration_sample_count": 123,
          "calibration_bin": "<string>",
          "expected_false_hits": 123,
          "family_wise_exceedance_probability": 123,
          "minimum_resolvable_probability": 123,
          "pair_tail_probability": 123,
          "q_value": 123
        }
      }
    ],
    "usage": {
      "logical_bytes_returned": 1,
      "billable_units": 1,
      "logical_bytes_read": 1
    }
  },
  "error": {
    "code": "<string>",
    "doc_url": "<string>",
    "message": "<string>",
    "details": {},
    "param": "<string>"
  },
  "evidence": {
    "warnings_count": 123,
    "duration_ms": 123,
    "input_refs": [
      "<string>"
    ],
    "object_refs": [
      "<string>"
    ],
    "output_refs": [
      "<string>"
    ],
    "row_count": 123
  }
}

{
  "$schema": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "$schema": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "$schema": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "$schema": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "$schema": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "$schema": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "$schema": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "$schema": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

Search for homologous protein sequences

Runs one protein-sequence search and returns the completed ranked results in the same response. Supply either a database id or slug to use its advertised current release, or supply one exact immutable database_release_id. The server resolves every scientific policy and reports every resolved identity, measurement, hash, warning, and usage value inline. No retained search resource, polling, or follow-up result request exists in the public API.

POST

homology

curl --request POST \
  --url https://api.rafflesia.ai/v1/homology \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "database": "<string>",
  "sequence": "<string>",
  "database_release_id": "<string>",
  "filter": {
    "filters": [
      "<unknown>"
    ],
    "op": "and",
    "field": "<string>",
    "filter": "<unknown>",
    "value": "<string>",
    "values": [
      "<string>"
    ]
  },
  "guarantee": "approximate",
  "include": [
    "alignment"
  ],
  "include_attributes": [
    "record_id"
  ],
  "limit": 25,
  "max_billable_units": 2,
  "significance": "not_requested"
}
'

import requests

url = "https://api.rafflesia.ai/v1/homology"

payload = {
    "database": "<string>",
    "sequence": "<string>",
    "database_release_id": "<string>",
    "filter": {
        "filters": ["<unknown>"],
        "op": "and",
        "field": "<string>",
        "filter": "<unknown>",
        "value": "<string>",
        "values": ["<string>"]
    },
    "guarantee": "approximate",
    "include": ["alignment"],
    "include_attributes": ["record_id"],
    "limit": 25,
    "max_billable_units": 2,
    "significance": "not_requested"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    database: '<string>',
    sequence: '<string>',
    database_release_id: '<string>',
    filter: {
      filters: ['<unknown>'],
      op: 'and',
      field: '<string>',
      filter: '<unknown>',
      value: '<string>',
      values: ['<string>']
    },
    guarantee: 'approximate',
    include: ['alignment'],
    include_attributes: ['record_id'],
    limit: 25,
    max_billable_units: 2,
    significance: 'not_requested'
  })
};

fetch('https://api.rafflesia.ai/v1/homology', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.rafflesia.ai/v1/homology",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'database' => '<string>',
    'sequence' => '<string>',
    'database_release_id' => '<string>',
    'filter' => [
        'filters' => [
                '<unknown>'
        ],
        'op' => 'and',
        'field' => '<string>',
        'filter' => '<unknown>',
        'value' => '<string>',
        'values' => [
                '<string>'
        ]
    ],
    'guarantee' => 'approximate',
    'include' => [
        'alignment'
    ],
    'include_attributes' => [
        'record_id'
    ],
    'limit' => 25,
    'max_billable_units' => 2,
    'significance' => 'not_requested'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rafflesia.ai/v1/homology"

	payload := strings.NewReader("{\n  \"database\": \"<string>\",\n  \"sequence\": \"<string>\",\n  \"database_release_id\": \"<string>\",\n  \"filter\": {\n    \"filters\": [\n      \"<unknown>\"\n    ],\n    \"op\": \"and\",\n    \"field\": \"<string>\",\n    \"filter\": \"<unknown>\",\n    \"value\": \"<string>\",\n    \"values\": [\n      \"<string>\"\n    ]\n  },\n  \"guarantee\": \"approximate\",\n  \"include\": [\n    \"alignment\"\n  ],\n  \"include_attributes\": [\n    \"record_id\"\n  ],\n  \"limit\": 25,\n  \"max_billable_units\": 2,\n  \"significance\": \"not_requested\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.rafflesia.ai/v1/homology")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"database\": \"<string>\",\n  \"sequence\": \"<string>\",\n  \"database_release_id\": \"<string>\",\n  \"filter\": {\n    \"filters\": [\n      \"<unknown>\"\n    ],\n    \"op\": \"and\",\n    \"field\": \"<string>\",\n    \"filter\": \"<unknown>\",\n    \"value\": \"<string>\",\n    \"values\": [\n      \"<string>\"\n    ]\n  },\n  \"guarantee\": \"approximate\",\n  \"include\": [\n    \"alignment\"\n  ],\n  \"include_attributes\": [\n    \"record_id\"\n  ],\n  \"limit\": 25,\n  \"max_billable_units\": 2,\n  \"significance\": \"not_requested\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.rafflesia.ai/v1/homology")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"database\": \"<string>\",\n  \"sequence\": \"<string>\",\n  \"database_release_id\": \"<string>\",\n  \"filter\": {\n    \"filters\": [\n      \"<unknown>\"\n    ],\n    \"op\": \"and\",\n    \"field\": \"<string>\",\n    \"filter\": \"<unknown>\",\n    \"value\": \"<string>\",\n    \"values\": [\n      \"<string>\"\n    ]\n  },\n  \"guarantee\": \"approximate\",\n  \"include\": [\n    \"alignment\"\n  ],\n  \"include_attributes\": [\n    \"record_id\"\n  ],\n  \"limit\": 25,\n  \"max_billable_units\": 2,\n  \"significance\": \"not_requested\"\n}"

response = http.request(request)
puts response.read_body

{
  "ok": true,
  "provenance": {
    "created_at": "<string>",
    "operation": "<string>",
    "request_id": "<string>",
    "server_version": "<string>",
    "cache_hit": true,
    "database_snapshots": [
      {
        "name": "<string>",
        "version": "<string>",
        "digest": "<string>",
        "kind": "<string>"
      }
    ],
    "generated_object_ids": [
      "<string>"
    ],
    "input_hash": "<string>",
    "parameters_hash": "<string>",
    "tool_versions": [
      {
        "name": "<string>",
        "version": "<string>",
        "path": "<string>"
      }
    ]
  },
  "warnings": [
    {
      "code": "<string>",
      "message": "<string>",
      "details": {}
    }
  ],
  "$schema": "<string>",
  "data": {
    "database": {
      "corpus_snapshot_id": "<string>",
      "id": "<string>",
      "release_id": "<string>",
      "searched_residue_count": 1,
      "searched_target_count": 1,
      "slug": "<string>",
      "canonical_filter_sha256": "<string>"
    },
    "is_result_limit_reached": true,
    "method": {
      "engine": "<string>",
      "is_deterministic": true,
      "is_exhaustive": true,
      "search_policy_id": "<string>",
      "semantic_profile_id": "<string>",
      "calibration_id": "<string>",
      "engine_release": "<string>"
    },
    "query": {
      "normalization_id": "<string>",
      "normalized_length": 123,
      "sha256": "<string>"
    },
    "result_sha256": "<string>",
    "results": [
      {
        "maxsim": {
          "bidirectional": 123,
          "query_to_target": 123,
          "target_to_query": 123
        },
        "rank": 123,
        "target": {
          "id": "<string>",
          "attributes": {}
        },
        "affine": {
          "normalized_score": 123,
          "raw_score": 123
        },
        "alignment": {
          "aligned_residue_count": 123,
          "cigar": "<string>",
          "cigar_dialect": "<string>",
          "coordinate_system": "<string>",
          "gap_opening_count": 123,
          "gap_residue_count": 123,
          "identical_residue_count": 123,
          "query_coverage_ratio": 123,
          "query_end": 123,
          "query_length": 123,
          "query_start": 123,
          "target_coverage_ratio": 123,
          "target_end": 123,
          "target_length": 123,
          "target_start": 123
        },
        "significance": {
          "calibration_id": "<string>",
          "calibration_sample_count": 123,
          "calibration_bin": "<string>",
          "expected_false_hits": 123,
          "family_wise_exceedance_probability": 123,
          "minimum_resolvable_probability": 123,
          "pair_tail_probability": 123,
          "q_value": 123
        }
      }
    ],
    "usage": {
      "logical_bytes_returned": 1,
      "billable_units": 1,
      "logical_bytes_read": 1
    }
  },
  "error": {
    "code": "<string>",
    "doc_url": "<string>",
    "message": "<string>",
    "details": {},
    "param": "<string>"
  },
  "evidence": {
    "warnings_count": 123,
    "duration_ms": 123,
    "input_refs": [
      "<string>"
    ],
    "object_refs": [
      "<string>"
    ],
    "output_refs": [
      "<string>"
    ],
    "row_count": 123
  }
}

{
  "$schema": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "$schema": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "$schema": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "$schema": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "$schema": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "$schema": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "$schema": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "$schema": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

Authorizations

Authorization

string

header

required

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

Headers

Idempotency-Key

string

Optional retry identity. Reuse the same key for the same request after an ambiguous failure. When omitted, the server derives an identity from the resolved scientific request.

Maximum string length: 255

Body

application/json

Option 1
Option 2

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

sequence

string

required

Raw amino-acid sequence text. ASCII whitespace is ignored, letters are uppercased, and one trailing stop symbol is removed. The normalized sequence may contain at most 100,000 residues.

Required string length: 1 - 110000

database_release_id

string

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

Minimum string length: 1

filter

object

Optional exact metadata predicate applied before candidate generation.

Show child attributes

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.

Required range: 1 <= x <= 10000

max_billable_units

integer<int64>

Optional hard ceiling on deterministic billable work. The search fails before exceeding it.

Required range: x >= 1

significance

enum<string>

default:not_requested

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

boolean

required

Whether the operation succeeded.

provenance

object

required

Execution provenance.

Show child attributes

warnings

object[] | null

required

Non-fatal warnings.

Show child attributes

$schema

string<uri>

read-only

A URL to the JSON Schema for this object.

Example:

"https://example.com/schemas/EnvelopeHomologyResponse.json"

data

object

Operation result data.

Show child attributes

error

object

Structured error information.

Show child attributes

evidence

object

Mechanical evidence summary for agent inspection and chaining.

Show child attributes

Errors

List searchable homology databases

Reference

Endpoints

Search for homologous protein sequences

Authorizations

Headers

Body

Response