Shipeasy
APIOperations

Attach a screenshot to an item

Attach a screenshot, screen recording, or file to a bug or feature request, so the fixer sees what QA saw instead of reconstructing it from measurements.…

Attach a screenshot, screen recording, or file to a bug or feature request, so the fixer sees what QA saw instead of reconstructing it from measurements. Send the bytes as contentBase64 (a bare base64 string or a data: URI) or give a public https url for the server to fetch — exactly one of the two. The kind (screenshot | recording | file) defaults from the media type. Up to 25 MiB.

Error and alert tickets cannot carry attachments (422). Append-only: there is no replace or delete, so it is safe for restricted ops keys.

Use case

A QA lane captures a screenshot at verification time and the filing agent attaches it to the bug or feature request it just filed.

POST
/api/admin/ops/{handle}/attachments

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/attachments" \  -H "Content-Type: application/json" \  -d '{    "filename": "checkout-overflow.png",    "contentBase64": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg=="  }'
{
  "id": "att_01j7w8a1b2c3d4e5f6g7h8i9j0",
  "filename": "checkout-overflow.png",
  "kind": "screenshot",
  "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?