The store opens at 9 AM on weekdays.
The store closes early on public holidays.
Contact the front desk with any questions.
" } ], "prompt": "Change the weekday opening time to 8 AM, add a weekend opening time of 10 AM after it, and remove the holiday hours.", "model": "agent-1", "responseFormat": "arf" } ``` 3. Read the `documents` array of the response. It holds one entry for each `document` part, in request order, each with the edited `document` and a `summary` of the changes. With `responseFormat: "arf"`, `document` is a fragment. See [Fragment responses](#fragment-responses). Requests are stateless: each request carries the documents, the model, and the instruction. The instruction is the `prompt`, or a prompt from a referenced context. A context that holds only files is not enough on its own. A request can also: - set `selection` on a `document` part, to limit the processing to character ranges of the HTML of that part; - set `editorConfig` on a `document` part, to describe the editing capabilities of the editor; - attach the prompts and files of a stored context with a `context` part; - turn on web search and reasoning with `capabilities`; - send headers for images that require authentication with `extraHttpHeaders`. A `context` part references a context that already exists. See [Contexts](../tinymceai-api-overview/#contexts). Not every model supports web search and reasoning. See [Model capabilities](../tinymceai-models/#model-capabilities). For each field, see [Process a document](https://tinymceai.api.tiny.cloud/v1/docs#tag/Document-processing/operation/processDocument) in the API reference. ## Streaming `POST /v1/documents/process/stream` returns the result as Server-Sent Events. For the events and their payloads, see [Process a document (streaming)](https://tinymceai.api.tiny.cloud/v1/docs#tag/Document-processing/operation/streamProcessDocument) in the API reference. For the wire format, see [SSE wire format](../tinymceai-streaming/#sse-wire-format), and for a parsing example, see [Basic implementation](../tinymceai-streaming/#basic-implementation). `responseFormat` changes only the events that stream the edits: `document-delta` events with `html`, and `modification-delta` events with `arf`. Both formats end with the same `document` event, which carries the full edited HTML and the summary. For a request with several documents, that event carries a `documents` array instead, with one entry for each document in request order, each with its `documentId`. For fragments in a stream, see [Fragments in a stream](#fragments-in-a-stream). ## Fragment responses With `responseFormat: "arf"`, the service returns a fragment in place of the whole document. ARF stands for Advanced Response Format. A fragment holds only the elements that changed, with an HTML comment in place of each run of unchanged elements, so a small edit to a long document returns a short response. ### What a fragment contains | Part | Markup | Meaning | | --- | --- | --- | | Edited element | The element with its new content and the `data-id` it has in the sent document. | Replace the element that has this `data-id`. | | Added element | The element with `data-id="new-element"`. | Insert a new element at this position. | | Removed element | `` | Delete the element that has this `data-id`, together with its children. | | Unchanged content | `` or `` | Keep one run of unchanged elements, however many elements the run contains. | ### Element identifiers Fragments refer to elements by their `data-id` attribute. Before sending a document: - Give every element a `data-id` that is unique within the document. Elements without a `data-id` cannot be matched to a fragment. - Keep an unchanged copy of the document as sent, and apply the fragment to that copy. After applying a fragment, give each added element a unique `data-id` before the next request. ### Applying a fragment Read the fragment in document order, and apply each part to the copy of the document that was sent: - Replace each edited element with the element from the fragment. A change inside an element, such as a new link or a bolded word, arrives as the whole element. An edited element can be nested, such as a list item, so match each `data-id` wherever the element is in the document. - Insert each added element between the elements that the fragment shows around it. An added element at the start of the fragment goes at the start of the document. - Delete each removed element. - Keep the elements that an unchanged-content comment stands for. For example, the request in [Process a document](#process-a-document) can return the following fragment: ```htmlThe store opens at 8 AM on weekdays.
On weekends, the store opens at 10 AM.
``` Applied to the sent document, the fragment gives this result, before the new paragraph receives a `data-id` of its own: ```htmlThe store opens at 8 AM on weekdays.
On weekends, the store opens at 10 AM.
Contact the front desk with any questions.
``` ### Fragments in a stream On `POST /v1/documents/process/stream`, a fragment arrives in `modification-delta` events. One modification arrives as several events that share an `id`, and a chunk can end anywhere, including in the middle of a tag or an attribute. Join the `textDelta` values of the events with the same `id`, in the order they arrive, before parsing the modification. For a request with several documents, the `documentId` of each event names the document that the modification applies to. The `documents` array of the final `document` event pairs each `documentId` with its document, in request order. ## Related features - [Document Processing permissions](../tinymceai-permissions/#document-processing-permissions): The `ai:documents:process` permission. - [Permissions error handling](../tinymceai-permissions/#error-handling): The response when a token lacks a permission. - [Streaming](../tinymceai-streaming/): Parsing Server-Sent Events. - [AI Models](../tinymceai-models/): Model IDs and capabilities. - [Error responses](../tinymceai-api-overview/#error-responses): The error body that every endpoint returns. - [Document processing API](https://tinymceai.api.tiny.cloud/v1/docs#tag/Document-processing): Request and response schemas, stream events, and error codes.