Skip to main content
Alpha: Document API is currently alpha and subject to breaking changes.

ā€‹
Summary

Get details for a specific image by its stable ID.
  • Operation ID: images.get
  • API member path: editor.doc.images.get(...)
  • Mutates document: no
  • Idempotency: idempotent
  • Supports tracked mode: no
  • Supports dry run: no
  • Deterministic target resolution: yes

ā€‹
Expected result

Returns an ImageSummary with full image properties.

ā€‹
Input fields

FieldTypeRequiredDescription
imageIdstringyes

ā€‹
Example request

{
  "imageId": "example"
}

ā€‹
Output fields

No fields.

ā€‹
Example response

{}

ā€‹
Pre-apply throws

  • TARGET_NOT_FOUND
  • AMBIGUOUS_TARGET

ā€‹
Non-applied failure codes

  • None

ā€‹
Raw schemas

{
  "additionalProperties": false,
  "properties": {
    "imageId": {
      "type": "string"
    }
  },
  "required": [
    "imageId"
  ],
  "type": "object"
}

{
  "type": "object"
}