Adaptyv Bio Foundry API

Use esta funcionalidade para transformar sequências de proteínas em dados medidos experimentalmente através do laboratório na nuvem da Adaptyv. Confirme o construto alvo, as condições do ensaio, os controles e o plano de réplicas antes de enviar um lote; o tempo de processamento depende do experimento.

Revisado contra o esquema OpenAPI implantado (info.version: 0.0.2) e o SDK oficial 0.1.0 no commit cdf207819ed5a58e0c127453626d2bce125c8064. A versão do esquema por si só não identifica todas as alterações. Consulte a referência de endpoint para obter detalhes atuais de requisição/resposta e discrepâncias em exemplos anteriores.

Conectar

URL Base: https://devs.adaptyvbio.com/api/v1. O esquema está em /openapi.json; nunca anexe esse nome de arquivo a requisições normais de endpoint.

Crie um token bearer em Foundry em Organização → Configurações → Tokens. Use Visualizador (Viewer) para leituras e Membro (Member) para escritas de experimentos. Leia as credenciais de ADAPTYV_API_KEY; a variável FOUNDRY_API_TOKEN na documentação é um nome alternativo para o mesmo token. Se estiver usando um projeto .env, chame explicitamente python-dotenv.load_dotenv() antes de configurar o SDK; o SDK não carrega esse arquivo automaticamente. Nunca imprima ou envie tokens para o repositório.

# ADAPTYV_API_KEY is already set in the environment.
curl --fail-with-body 'https://devs.adaptyvbio.com/api/v1/targets?limit=3' \
  -H "Authorization: Bearer $ADAPTYV_API_KEY"

Endpoints de recursos exigem autenticação bearer. O esquema e o endpoint de liveness GET /info/health são públicos. GET /whoami informa a organização ativa e as permissões; verifique-o quando o escopo da conta não estiver claro.

SDK Python

Instale a revisão revisada em seu ambiente de projeto (requer Python 3.11+):

uv pip install "git+https://github.com/adaptyvbio/adaptyv-sdk.git@cdf207819ed5a58e0c127453626d2bce125c8064"

Importe de adaptyv, não de adaptyv_sdk. FoundryClient requer explicitamente api_key e base_url; o objeto de conveniência lab lê ADAPTYV_API_KEY e ADAPTYV_API_URL. Defina este último para a URL base acima para substituir o hostname padrão mais antigo do SDK.

Os exemplos a seguir são ilustrativos para uso autenticado. A construção e análise de suas requisições foram verificadas com respostas HTTP simuladas, não com uma execução de laboratório paga. Substitua as entradas de ambiente por dados de sequência reais e revisados e IDs de catálogo.

Navegar, estimar, criar um rascunho

import json
import os
from pathlib import Path
from adaptyv import FoundryClient

client = FoundryClient(
    api_key=os.environ["ADAPTYV_API_KEY"],
    base_url="https://devs.adaptyvbio.com/api/v1",
)

# Review vendor, catalog number, construct, and pricing before selecting an ID.
targets = client.targets.list(search="EGFR", selfservice_only=True, detailed=True)
for target in targets.items:
    print(target.id, target.name, target.vendor_name, target.catalog_number)

# candidates.json is a map of unique names to full amino acid sequences.
sequences = json.loads(Path("candidates.json").read_text())
spec = {
    "experiment_type": "screening",
    "method": "bli",
    "target_id": os.environ["ADAPTYV_TARGET_ID"],
    "sequences": sequences,
    "n_replicates": 3,
}

# SDK takes the spec itself; REST takes {"experiment_spec": spec}.
estimate = client.experiments.cost_estimate(spec)
if estimate.breakdown is None:
    raise ValueError("Incomplete estimate: review warnings and obtain a full quote")
print("Estimated USD cents, excluding VAT:", estimate.breakdown.total_cents)

# After the batch and estimated cost have been reviewed:
exp = client.experiments.create(name="EGFR binder screen batch 1", experiment_spec=spec)
experiment_id = exp.experiment_id
client.close()

create(name=..., experiment_spec=...) não aceita um único dicionário no corpo da requisição REST. cost_estimate(spec) encapsula a própria especificação; não a encapsule uma segunda vez. Para um experimento de afinidade, o SDK adicionalmente requer antigen_concentrations explícito, mesmo que a REST forneça um padrão quando omitido.

Enviar, então inspecionar e confirmar a cotação

Com um cliente configurado e o experiment_id salvo:

client.experiments.submit(experiment_id)
# A geração da cotação é assíncrona. Tente obter_cotação novamente com um tempo limite limitado se
# retornar 404 após o envio bem-sucedido; um rascunho não tem cotação iminente.
quote = client.experiments.get_quote(experiment_id)
print(quote.amount_total, quote.currency, quote.expires_at)


…