Skip to main content
POST
Search project context documents

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
resourceIds
string[]
required

Selected text resource ids from the project context index, in relevance order.

Required array length: 1 - 25 elements
Minimum string length: 1
queries
string[]
required

Independent case-insensitive literal terms matched within a line, not questions or regular expressions.

Required array length: 1 - 8 elements
Required string length: 1 - 500
Pattern: ^[^\r\n]+$
contextLines
integer
default:2
Required range: 0 <= x <= 5
maxCharacters
integer
default:8000

Shared passage character budget across all documents and queries.

Required range: 4000 <= x <= 16000

Response

Deduplicated passages, query coverage, and unavailable resource ids.

queries
object[]
required
passages
object[]
required
unavailableResourceIds
string[]
required