Document apiReferenceFields

fields.get

Get detailed information about a specific field.

read-onlyidempotent
doc.fields.get(…)

Expected result

Returns a FieldInfo object with the field's instruction, result text, and nesting data.

Inputs

targetobjectrequired
Fields
kind"field"required
blockIdstringrequired
occurrenceIndexintegerrequired
nestingDepthinteger
storyIdstring
fieldIdstring

Result

Output fields

No fields.

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • CAPABILITY_UNAVAILABLE

Raw schemas

Open the generated JSON artifact for the exact input, output, success, and failure schemas represented by this contract version.

View raw JSON schemas