Skip to content

list_inference_tools

List the Layer tools the user can run in the workspace, such as `image.upscale` or `video.reframe`.

A tool is one job (upscale an image, make a seamless texture, reframe a video) that runs on any
model in its pool; it shows only the fields that job needs and fixes the rest. Each tool names the
base models the user can run it on and the one a run takes when it names none. Prefer a tool to
`execute_forge` when the user's request is one of these jobs.

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.
modalityenum—Only the tools that make this modality.
One of: text, image, audio, video, three_d, playable, world
groupenum—Only the tools that make something new (`generate`) or change an asset (`edit`).
One of: generate, edit
paginationPaginationInput—Page through the tools; without it, the first 20.
limitinteger1–10020Maximum number of results to return
cursorstring—Cursor from which to return results