Skip to main content
    Ivy Biosciences Docs/Call the platform/API/REST API/Lookup REST API

    Lookup REST API

    UniProt and PubChem lookups and synchronous calculations on the web app domain

    restlookupsync

    Lookup endpoints give you fast protein and compound data plus real-time sync calculations, without the submit-and-poll cycle of a full job. Reach for them when you need immediate answers: UniProt or PubChem lookups, or sync calculations for on-the-spot analysis. Use these for lightweight, interactive queries; for longer GPU-backed compute, use the Jobs API instead.

    Difficulty

    beginner

    Time

    8 min

    Lookup & Sync Calculations

    Lookup endpoints for protein and compound data, plus sync calculations for real-time analysis.

    Base URL: https://www.ivybiosciences.com/api/v1

    Every route on this page needs an ivy_ API key or a Clerk session JWT in the Authorization header. See Authentication. The web app checks your credential and forwards the call to the compute backend on your behalf, with your own credential. Other lookup paths return 404.

    Parameters and response shapes: every lookup and sync calculation on this page has its own page in the API Reference.

    curl "https://www.ivybiosciences.com/api/v1/lookup/uniprot?protein_name=TP53&organism=Homo%20sapiens&limit=3" \
      -H "Authorization: Bearer ivy_your_key"

    Lookups

    UniProt Lookup

    GET /api/v1/lookup/uniprot searches UniProt by protein or gene name. Query parameters: protein_name (required), organism, limit (1-50).

    PubChem Lookup

    GET /api/v1/lookup/pubchem searches PubChem by compound name. Query parameters: ligand_name (required), limit (1-50).

    Enhanced Molecule Analysis

    GET /api/v1/lookup/molecule/enhanced analyzes one molecule. Query parameter: smiles (required).


    Sync Calculations

    These endpoints return results synchronously, with no job queue. Send a JSON body.

    curl -X POST "https://www.ivybiosciences.com/api/v1/sync/validate-smiles" \
      -H "Authorization: Bearer ivy_your_key" \
      -H "Content-Type: application/json" \
      -d '{"smiles": "CCO"}'

    Molecular Properties

    POST /api/v1/sync/molecular-properties.

    ADMET Quick

    POST /api/v1/sync/admet-quick.

    POST /api/v1/sync/similarity.

    SMILES Validation

    POST /api/v1/sync/validate-smiles.

    Errors

    StatusMeaning
    401Missing or invalid credential
    404Unknown path
    405Wrong HTTP method for the route
    422The request failed validation; the body says which field
    502The compute service is unavailable. Retry with backoff

    Was this page helpful?

    On this page

    On this page

    Loading...