Skip to content

get_inference_tool

Get a Layer tool's fields on one of its base models, to fill in `input` for `run_inference_tool`.

Returns the tool's summary, the base model the fields are for and the JSON Schema of `input`.
The schema says whether the tool works on a source file and whether the model takes a mask.

IMPORTANT: Call tool `get_instructions` first for general platform guidance.

Parameters

ParameterTypeDefaultDescription
project_idstring (uuid)—Optional project the work would be filed in: the models and defaults answered are those a run in it gets. Use `list_projects` to find project ids. Without it or `session_id`, the answer is for the workspace.
session_idstring (uuid)—Optional session the work would land in: the answer is for its project. With `project_id`, the session must be in that project.
workspace_idrequiredstring (uuid)—The user's workspace id.
inference_tool_keyrequiredstring—The tool's key, such as `image.upscale`, from `list_inference_tools`.
base_model_idstring—The base model whose fields to return, by ID, slug, name or alias: one of the tool's `base_model_ids`. Without it, the fields are for the model a run takes when it names none.