AI document assistance (streaming, EE)

Streams AI-generated document edits using the tenant's configured LLM provider. Enterprise Edition feature gated by the AI add-on tier and a feature flag; authenticated with the AI_DOCUMENT_API_KEY via the x-api-key header. Returns a streamed text response (501 on Community Edition).

Request body

Content type: application/json · schema AiDocumentAssistBody

instructionstringRequired

What the assistant should do.

documentContextstringRequired

Current document text/context.

documentIdstring <uuid>

tenantIdstring <uuid>Required

connectedUserNamesarray of string

itemsstring

Response body

Success response 200 · schema PublicV1Success

dataanyOfRequired

anyOf (option 1)object

anyOf (option 2)array of object

itemsobject

metaobject

Response codes

200

Streamed AI edit suggestions (text/event-stream).

401

AI_DOCUMENT_API_KEY missing/invalid.

403

AI add-on/feature flag not enabled.

500

Unexpected error.

501

Not available on Community Edition.

POST /api/v1/ai/document-assist

cURL

curl -X POST "https://algapsa.com/api/v1/ai/document-assist" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "instruction": "string",
  "documentContext": "string",
  "documentId": "01HN2K7VRB9PQ3Y0000000000",
  "tenantId": "01HN2K7VRB9PQ3Y0000000000",
  "connectedUserNames": [
    "string"
  ]
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/ai/document-assist", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "instruction": "string",
    "documentContext": "string",
    "documentId": "01HN2K7VRB9PQ3Y0000000000",
    "tenantId": "01HN2K7VRB9PQ3Y0000000000",
    "connectedUserNames": [
      "string"
    ]
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://algapsa.com/api/v1/ai/document-assist");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""instruction"": ""string"",
  ""documentContext"": ""string"",
  ""documentId"": ""01HN2K7VRB9PQ3Y0000000000"",
  ""tenantId"": ""01HN2K7VRB9PQ3Y0000000000"",
  ""connectedUserNames"": [
    ""string""
  ]
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

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