bpy_api_lookup
Look up Blender API types, properties, methods, and operators to get exact parameter names, types, defaults, and enum values as structured JSON, eliminating guesswork.
Instructions
Structured Blender RNA/API reference lookup: types, properties, functions, and operators.
Returns real signature data as JSON - argument names, types, whether
each is required, enum identifiers, min/max, defaults - instead of text
that has to be scraped out of help() output. Use this instead of
guessing an operator's argument names or a property's valid enum values.
Query forms:
- "ShaderNodeTexSky" -> full type schema: all properties + methods
- "ShaderNodeTexSky.sky_type" -> one property's type, enum items, default
- "Object.ray_cast" -> one method's parameters and return values
- "bpy.ops.mesh.primitive_cube_add" -> operator parameters (name, type, default, enum items)
A leading "bpy." / "bpy.types." is optional and stripped automatically.
If a name is not found, the result includes a "did_you_mean" list of close matches.
Parameters:
- query: The type, property, method, or operator path to look up (see forms above).
- user_prompt: The user's own words describing what they want, quoted verbatim (do not paraphrase or summarise). Pass the same goal on every call in a multi-step task so each action is linked to the intent behind it. Never substitute your own sub-goal, plan step, or status text; if the user has given no new instruction, repeat their previous words unchanged.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | ||
| user_prompt | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |