Project Context

Finalize project context upload

Verifies the uploaded bytes, normalizes the file in isolation, and generates its index description.

post/websiteKnowledge/{resourceId}/finalize

Request

  • Base URL: https://api.cactal.ai/v1
  • URL: https://api.cactal.ai/v1/websiteKnowledge/{resourceId}/finalize
  • Auth: HTTP bearer

Path parameters

resourceIdstring required

Response

The completed resource.

idstring required
titlestring required
origin'upload' | 'text' required
filenamestring required
mimeType'application/pdf' | 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' | 'text/plain' | 'text/markdown' | 'image/png' | 'image/jpeg' | 'image/webp' | 'image/svg+xml' required
byteSizeinteger required
descriptionstring required
lineCountinteger nullable required
transparentSharenumber nullable required

Fraction of the backdrop that shows through, weighting each pixel by its transparency: 0 for an opaque image, roughly the background area for a cutout, 0.5 for a uniform 50% overlay. null when unknown.

translucentSharenumber nullable required

Fraction of pixels with partial alpha (soft shadows, glows, fades, glass), excluding fully transparent and fully opaque pixels. null when unknown.

createdAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.