Shipeasy
APIOperations

Upload an image to embed in a comment

Upload an image to embed in a comment on a queue item. Takes the same body as the attachment upload (contentBase64 or url). The response carries a relative…

Upload an image to embed in a comment on a queue item. Takes the same body as the attachment upload (contentBase64 or url). The response carries a relative url — reference it from the comment body as a markdown image (![caption](url)) in ops comments create, so an evidence comment shows the screenshot inline.

Append-only, safe for restricted ops keys.

Use case

Put a screenshot inside an evidence comment rather than on the item itself.

POST
/api/admin/ops/{handle}/comment-media

Authorization

bearerSdkKey
AuthorizationBearer <token>

Pass an admin SDK key as Authorization: Bearer sdk_admin_…. Mint via POST /api/admin/keys with type: "admin".

In: header

Path Parameters

handle*string

Per-project item number (e.g. 7) or the full ops item id.

Length1 <= length <= 128

Header Parameters

X-Project-Id?string

Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://shipeasy.ai/api/admin/ops/string/comment-media" \  -H "Content-Type: application/json" \  -d '{    "filename": "checkout-overflow.png",    "contentBase64": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg=="  }'
{
  "id": "cmm_01j7w8a1b2c3d4e5f6g7h8i9j0",
  "url": "/api/admin/ops/comment-media/cmm_01j7w8a1b2c3d4e5f6g7h8i9j0",
  "mimeType": "image/png",
  "sizeBytes": 68
}
{
  "error": "Malformed request (bad JSON, missing project scope).",
  "code": "BAD_REQUEST"
}
{
  "error": "Missing or invalid admin SDK key.",
  "code": "UNAUTHORIZED"
}

{
  "error": "Key is valid but not allowed to act on this project.",
  "code": "FORBIDDEN"
}

{
  "error": "The resource does not exist or is not visible to the caller.",
  "code": "NOT_FOUND"
}
{
  "error": "Body too large",
  "code": "BAD_REQUEST"
}

{
  "error": "The request body failed structural (schema) validation.",
  "code": "VALIDATION"
}

Was this page helpful?