Get a ticket document preview image

Serves the cached 800x600 fit-inside JPEG preview for an image, PDF, or video document attached to a ticket. Generated on first request for older uploads. Responds with an ETag and long-lived Cache-Control; honors If-None-Match with 304. Returns 404 for document types that have no preview.

RBAC · ticket

Path parameters

idstring <uuid>Required

Ticket UUID.

documentIdstring <uuid>Required

Document UUID.

Response body

Success response 200 · schema WorkV1ApiSuccess

dataanyOfRequired

anyOf (option 1)object

anyOf (option 2)array of object

itemsobject

metaobject

Response codes

200

Binary preview image (image/jpeg).

304

Not modified (ETag matched If-None-Match).

401

API key missing/invalid.

403

RBAC denied for ticket resource action.

404

Document not found or has no preview.

500

Unexpected failure.

GET /api/v1/tickets/{id}/documents/{documentId}/preview

cURL

curl -X GET "https://algapsa.com/api/v1/tickets/{id}/documents/{documentId}/preview" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/tickets/{id}/documents/{documentId}/preview", {
  method: "GET",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
  }
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://algapsa.com/api/v1/tickets/{id}/documents/{documentId}/preview");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": {},
  "meta": {}
}