Skip to main content
POST
Add project context from text

Authorizations

Authorization
string
header
required

Cactal API key. Create one in the dashboard or via POST /apiKeys. The plaintext key is shown once at creation.

Body

application/json
websiteId
string
required
Minimum string length: 1
text
string
required

The text to keep, as plain text or Markdown.

Maximum string length: 1000000

Response

The new context entry.

id
string
required
title
string
required
origin
enum<string>
required
Available options:
upload,
text
filename
string
required
mimeType
enum<string>
required
Available options:
application/pdf,
application/vnd.openxmlformats-officedocument.wordprocessingml.document,
text/plain,
text/markdown,
image/png,
image/jpeg,
image/webp,
image/svg+xml
byteSize
integer
required
description
string
required
lineCount
integer | null
required
colors
object[] | null
required

Up to 8 representative colors sorted by share. null for files and for images that could not be analyzed.

Maximum array length: 8
transparentShare
number | null
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.

Required range: 0 <= x <= 1
translucentShare
number | null
required

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

Required range: 0 <= x <= 1
createdAt
string<date-time>
required