Skip to main content
    Ivy Biosciences Docs/Call the platform/API/Sessions API/Tools registry

    Tools registry

    List and inspect available AI tools with full parameter schemas

    sessionstoolsregistry

    These endpoints list the tools a session can run and return each one's parameter schema and plan tier. Reach for them when you're building a UI that offers tools to pick from, validating input, or deciding what a session should be allowed to call. The tools you discover here are the same ones the model invokes during a turn in Message execution.

    Difficulty

    beginner

    Time

    5 min

    Prerequisites

    Tools Registry

    GET /api/v1/tools lists the tools a session can call; GET /api/v1/tools/:name returns one tool's parameter schema.

    With a key, GET /api/v1/tools (reference) returns the catalogue: each tool's name, display_name, category, a one-line description, tier and requires_gpu. It has no parameter schemas; read those one tool at a time. Without a key both routes return 401.

    curl "https://www.ivybiosciences.com/api/v1/tools" \
      -H "Authorization: Bearer ivy_your_key"

    Get Tool Schema

    GET /api/v1/tools/:name returns one tool's definition, including its parameter schema (reference).

    curl "https://www.ivybiosciences.com/api/v1/tools/diffdock" \
      -H "Authorization: Bearer ivy_your_key"

    Tool Categories

    category values come from the tool definitions, for example database, bioinformatics, omics, literature, structure, docking, admet, design and synthesis. Read the category field of the catalogue for the full set rather than hard-coding it, and filter on it client-side.

    For the job-based compute tools, see Job Types Catalog.

    Was this page helpful?

    On this page

    On this page

    Loading...