# API Reference

> Find DS Server endpoints, classes and members: the Web API for DocumentProcessing, OAuth, administration and licensing, the .NET packages and JavaScript APIs.

- **Product:** DS Server
- **Section:** Documentation
- **Kind:** Topic
- **Path:** DS Server > API Reference
- **859 words**
- **Web URL:** https://docs.textcontrol.com/ds-server/reference/
- **LLMs URL:** https://docs.textcontrol.com/ds-server/reference/llms.txt
- **LLMs-Full URL:** https://docs.textcontrol.com/ds-server/reference/llms-full.txt

---

When you know what you want DS Server to do and need the exact endpoint, class or member, look it up in the API Reference. It documents the three ways your code talks to DS Server: the HTTP endpoints of the Web API, the .NET packages that call them from C# and the JavaScript objects that control the Document Editor and the Document Viewer in the browser.

The guide pages of this documentation explain the tasks and link the endpoints and members they use to their pages here. Use the reference to check a parameter, a request body, a status code or the members of a class.

### What the Reference Covers

| Part | What it documents | Where the code runs |
|---|---|---|
| [Web API](https://docs.textcontrol.com/ds-server/reference/web-api/llms-full.txt) | The public endpoints of DS Server, grouped as DocumentProcessing, OAuth, Administration, Licensing and Authentication Server, with their requests, responses and errors | Any application that sends HTTP requests |
| [.NET API](https://docs.textcontrol.com/ds-server/reference/dotnet-api/llms-full.txt) | The NuGet packages `TXTextControl.DocumentServices.DocumentProcessing`, `TXTextControl.DocumentServices.Admin` and `TXTextControl.DocumentServices.Plugin.Abstractions` | In your .NET application, or inside DS Server as a plugin |
| [JavaScript API](https://docs.textcontrol.com/ds-server/reference/javascript-api/llms-full.txt) | The `TXTextControl` object of the Document Editor and the `TXDocumentViewer` object of the Document Viewer | In the browser |

The settings of the ASP.NET Core, Angular and React components are listed on their pages in [Client-Side Libraries](https://docs.textcontrol.com/ds-server/client-libraries/llms-full.txt).

### The Web API

The Web API is the foundation: the client libraries, the components and your own HTTP requests all use it. Its five groups are:

- **DocumentProcessing**: 16 endpoints below `/documentprocessing/` that convert, merge, append, search and replace, inspect and render documents, create and read PDF documents and create barcodes.
- **OAuth**: `/oauth/authorize` and `/oauth/token`, which issue the access tokens that the other endpoints require when OAuth is enabled, and `/oauth/validatetoken` and `/oauth/test`, which check a token.
- **Administration**: the endpoints below `/admin/` that change the admin password, manage security profiles and authentication servers, and switch OAuth on or off.
- **Licensing**: the endpoints below `/license/` that register the server online or offline, renew or remove its license, validate a serial number and create a license request string.
- **Authentication Server**: the endpoints below `/authenticationserver/` that issue tokens like the OAuth endpoints, but never forward a request to other authentication servers.

Most endpoint pages show a curl request and its response, so that you can try a call before writing code.

### Find the Right Page

| If you want to | Read |
|---|---|
| Send a document to DS Server and get a PDF back | [POST /documentprocessing/document/convert](https://docs.textcontrol.com/ds-server/reference/web-api/documentprocessing/document-convert/post/llms-full.txt) |
| Merge a template with JSON data | [POST /documentprocessing/document/merge](https://docs.textcontrol.com/ds-server/reference/web-api/documentprocessing/document-merge/post/llms-full.txt) |
| Request an access token | [POST /oauth/token](https://docs.textcontrol.com/ds-server/reference/web-api/oauth/token/post/llms-full.txt) |
| Create security profiles from a script | [Administration](https://docs.textcontrol.com/ds-server/reference/web-api/administration/llms-full.txt) |
| Find the C# method for an endpoint | [.NET API](https://docs.textcontrol.com/ds-server/reference/dotnet-api/llms-full.txt) |
| Call the Document Editor or the Document Viewer from JavaScript | [JavaScript API](https://docs.textcontrol.com/ds-server/reference/javascript-api/llms-full.txt) |
| Learn a task before looking up its endpoint | [Document Processing](https://docs.textcontrol.com/ds-server/document-processing/llms-full.txt) |

### Pages in This Section

- [Web API](https://docs.textcontrol.com/ds-server/reference/web-api/llms-full.txt): the HTTP endpoints of DS Server.
- [.NET API](https://docs.textcontrol.com/ds-server/reference/dotnet-api/llms-full.txt): the .NET packages for DocumentProcessing, administration and plugins.
- [JavaScript API](https://docs.textcontrol.com/ds-server/reference/javascript-api/llms-full.txt): the browser APIs of the Document Editor and the Document Viewer.

---

## In This Section

- [.NET API](https://docs.textcontrol.com/ds-server/reference/dotnet-api/llms-full.txt): The namespaces and main classes of the DS Server NuGet packages DocumentProcessing, Admin and Plugin.Abstractions, and which package a C# class comes from.
- [JavaScript API](https://docs.textcontrol.com/ds-server/reference/javascript-api/llms-full.txt): Control the DS Server Document Editor with the TXTextControl object and the Document Viewer with TXDocumentViewer: scripts, init settings, events and reference.
- [JavaScript API - Document Viewer](https://docs.textcontrol.com/ds-server/reference/javascript-document-viewer/llms-full.txt): Annotations Class CompletedFormField Class ContextualToolbar Class DefaultItemTypes Enumerations DefaultToolbarItemDescriptor Class DocumentData Object DocumentLinkClickedEventArgs Object DocumentLoadSettings Class DocumentSaveResult Class DocumentSaveSettings Class DocumentViewerController Class DocumentViewerElement Class DocumentViewerSettings Class DownloadDocumentResult Class Forms Class HypertextLinkClickedEventArgs Object OAuthSettings Class PDFJSSettings Class SignatureBeforeSubmitCallback Function SignatureBox Object SignatureBox.SignatureBoxStyle Enumerations SignatureFontSettings Class Signatures Class SignatureSettings Class SignatureSubmitCallback Function StampDefinition Class StreamType Enumerations Toolbar Class ToolbarButton Class ToolbarItem Object TrackedChange Class TrackedChanges Class TXDocumentViewer Object ViewerEvents Enumerations ViewerInitSettings Object ZoomChangedEventArgs Object
- [JavaScript API](https://docs.textcontrol.com/ds-server/reference/javascript/llms-full.txt): AddCommentCallback Function AddEditableRegionCallback Function AddFootnoteCallback Function AddSubTextPartCallback Function ApplicationField Object ApplicationFieldCollection Object Barcode Object BarcodeCallback Function BarcodeCollection Object BarcodeEventArgs Object BarcodeFrame Object BarcodeTypeSettings Object CannotTrackChangeCallback Function ChartCallback Function ChartEventArgs Object CheckFormField Object CheckFormFieldCallback Function CheckFormFieldEventArgs Object CheckFormFieldInfo Object ClipboardDataTransferAbortedCallback Function ClipboardDataTransferCompleteCallback Function ClipboardDataTransferProgressCallback Function ClipboardDataTransferStartCallback Function ClipboardModeChangedCallback Function ClipboardModeChangedEventArgs Object ClipboardTransferAbortedEventArgs Object ClipboardTransferCompleteEventArgs Object ClipboardTransferProgressEventArgs Object ClipboardTransferStartEventArgs Object Collection Object CommentCallbackData Object CommentCollection Object CommentedText Object CommentedTextInfo Object CommentEventArgs Object CommentEventCallback Function ComponentSettings Object ContextMenuEventArgs Object ContextMenuEventCallback Function ContextMenuItem Object ContextMenuItemClickEventArgs Object ContextMenuItemClickHandler Function CultureSettings Object DateFormField Object DateFormFieldCallback Function DateFormFieldEventArgs Object DateFormFieldInfo Object DictionaryInfo Object Distances Object DocumentEditorSettings Object DocumentLink Object DocumentLinkCallback Function DocumentLinkCollection Object DocumentLinkEventArgs Object DocumentLoadedCallback Function DocumentLoadedEventArgs Object DocumentPermissions Object DocumentSettings Object DocumentTarget Object DocumentTargetCollection Object DocumentTargetInfo Object DrawingCallback Function DrawingEventArgs Object EditableRegion Object EditableRegionCallback Function EditableRegionCallbackData Object EditableRegionCollection Object EditableRegionEventArgs Object EmbeddedFile Object EmbeddedFileCollection Object EmptyRequestCallback Function ErrorArgument Object ErrorCallback Function EventCallback Function FileDroppedCallback Function FileDroppedEventArgs Object Footnote Object FootnoteCallback Function FootnoteCallbackData Object FootnoteCollection Object FootnoteEventArgs Object ForEachCallback Function FormattedText Object FormattingStyle Object FormattingStyleCollection Object FormField Object FormFieldCollection Object FrameBase Object FrameBaseCollection Object FrameCallback Function FrameCollection Object FrameEventArgs Object FrameInfo Object GetDictionaryListCallback Function GetUserDictionaryInfoCallback Function HeaderFooter Object HeaderFooterCallback Function HeaderFooterCollection Object HeaderFooterEventArgs Object HyperlinkClickedCallback Function HyperlinkClickedEventArgs Object HyperLinkInfo Object HypertextLink Object HypertextLinkClickedCallback Function HypertextLinkCollection Object HypertextLinkEventArgs Object HyphenateWordCallback Function HyphenateWordEventArgs Object Image Object ImageCallback Function ImageCollection Object ImageEventArgs Object InlineStyle Object InlineStyleCollection Object InputFormat Object InputPosition Object InputPositionChangedCallback Function InputPositionChangedEventArgs Object Line Object LineCollection Object ListFormat Object LoadDocumentCallback Function LoadDocumentCallbackData Object MisspelledWord Object MisspelledWordCollection Object MisspelledWordInfo Object Page Object PageBorder Object PageCollection Object PageMargins Object PageNumberField Object PageNumberFieldCollection Object PageSize Object Paragraph Object ParagraphCollection Object ParagraphFormat Object ParagraphStyle Object ParagraphStyleCollection Object Point Object PropertyChangedCallback Function PropertyChangedEventArgs Object ReconnectionFailedCallback Function ReconnectionFailedEventArgs Object Rectangle Object RequestActivationStateCallback Function RequestApplicationFieldCallback Function RequestAutoBaselineCallback Function RequestBarcodeAlignmentCallback Function RequestBarcodeFrameCallback Function RequestBarcodeTextAlignmentCallback Function RequestBarcodeTypeCallback Function RequestBooleanCallback Function RequestCapitalsCallback Function RequestCellFormatCallback Function RequestChangeKindCallback Function RequestCheckFormFieldCallback Function RequestCollectionElementCallback Function RequestColorStringCallback Function RequestCommentCallback Function RequestCommentsCallback Function RequestDateFormFieldCallback Function RequestDirectionCallback Function RequestDistancesCallback Function RequestDocumentLinkCallback Function RequestDocumentTargetCallback Function RequestEditableRegionsCallback Function RequestEditModeCallback Function RequestFontUnderlineStyleCallback Function RequestFormattingStyleCallback Function RequestFormFieldCallback Function RequestFormulaReferenceStyleCallback Function RequestFrameBaseCallback Function RequestFrameCallback Function RequestFrameInsertionModeCallback Function RequestFrameStyleCallback Function RequestHeaderFooterCallback Function RequestHeaderFooterTypeCallback Function RequestHighlightModeCallback Function RequestHorizontalAlignmentCallback Function RequestHypertextLinkCallback Function RequestImageCallback Function RequestInlineStyleCallback Function RequestJustificationCallback Function RequestLineCallback Function RequestListFormatCharacterCallback Function RequestMeasuringUnitCallback Function RequestMisspelledWordCallback Function RequestNumberCallback Function RequestNumberFormatCallback Function RequestNumberFormatsCallback Function RequestNumbersCallback Function RequestObjectCallback Function RequestPageCallback Function RequestPageNumberFieldCallback Function RequestPaperSizeCallback Function RequestParagraphCallback Function RequestParagraphFormatCallback Function RequestParagraphStyleCallback Function RequestPermanentControlCharsCallback Function RequestPointCallback Function RequestRectangleCallback Function RequestRenderModeCallback Function RequestRulerBarBorderStyleCallback Function RequestRulerBarFormulaModeCallback Function RequestRulerBarScaleUnitCallback Function RequestSectionBreakKindCallback Function RequestSectionCallback Function RequestSelectionBoundsCallback Function RequestSelectionFormFieldCallback Function RequestSignatureFieldCallback Function RequestSignatureImageCallback Function RequestSignerDataCallback Function RequestSizeCallback Function RequestStatusBarBorderStyleCallback Function RequestStringCallback Function RequestStringsCallback Function RequestSubTextPartCallback Function RequestSubTextPartsCallback Function RequestTableCallback Function RequestTableCellCallback Function RequestTableColumnCallback Function RequestTableOfContentsCallback Function RequestTableRowCallback Function RequestTabTypesCallback Function RequestTextCharCallback Function RequestTextFieldCallback Function RequestTextFieldInfoArrayCallback Function RequestTextFieldsCallback Function RequestTextFormFieldCallback Function RequestTextFrameCallback Function RequestTextPartCallback Function RequestTextPartsCallback Function RequestTextTypeCallback Function RequestTrackedChangeCallback Function RequestVerticalAlignmentCallback Function RequestViewModeCallback Function Ribbon Object RibbonPermissionsTab Object RibbonTabIndexChangedCallback Function RibbonTabIndexChangedEventArgs Object RibbonTabLoadedCallback Function RibbonTabLoadedEventArgs Object RibbonTabsLoadedCallback Function RulerBarViewGenerator Object RulerBarViewGeneratorColors Object SaveDocumentCallback Function SaveDocumentResult Object SaveDocumentResultCallback Function SaveUserDictionaryCallback Function Section Object SectionCollection Object SectionFormat Object Selection Object SelectionBounds Object SelectionFormField Object SelectionFormFieldCallback Function SelectionFormFieldEventArgs Object SelectionFormFieldInfo Object SideBarToggleButton Object SideBarTypeRequestCallback Function SignatureField Object SignatureFieldCallback Function SignatureFieldCollection Object SignatureFieldEventArgs Object SignatureFieldInfo Object SignatureImage Object SignatureImageInfo Object SignerData Object Size Object SpellCheckTextCallback Function SpellCheckTextEventArgs Object StatusBarViewGenerator Object StatusBarViewGeneratorColors Object SubTextPart Object SubTextPartCallback Function SubTextPartCallbackData Object SubTextPartCollection Object SubTextPartEventArgs Object SubTextPartInfo Object Table Object TableBaseCollection Object TableCallback Function TableCell Object TableCellBorder Object TableCellCollection Object TableCellFormat Object TableCollection Object TableColumn Object TableColumnCollection Object TableEventArgs Object TableInfo Object TableOfContents Object TableOfContentsCallback Function TableOfContentsCollection Object TableOfContentsCollectionAddParams Object TableOfContentsEventArgs Object TableOfContentsInfo Object TableRow Object TableRowCollection Object TextChar Object TextCharCollection Object TextControlChangedCallback Function TextControlLoadedCallback Function TextDroppedCallback Function TextDroppedEventArgs Object TextField Object TextFieldCallback Function TextFieldCollection Object TextFieldCollectionBase Object TextFieldEventArgs Object TextFieldInfo Object TextFormField Object TextFormFieldCallback Function TextFormFieldEventArgs Object TextFormFieldInfo Object TextFrame Object TextFrameCallback Function TextFrameCollection Object TextFrameEventArgs Object TextPart Object TextPartCollection Object TextPastedCallback Function TextPastedEventArgs Object TextViewGeneratorColors Object TextViewLocationChangedCallback Function TextViewLocationChangedEventArgs Object TrackedChange Object TrackedChangeCallback Function TrackedChangeCollection Object TrackedChangeEventArgs Object TrackedChangeInfo Object TXTextControl Object TXTextControl.ApplicationField Object TXTextControl.BarcodeType Object TXTextControl.Color Object TXTextControl.DateField Object TXTextControl.IfField Object TXTextControl.IncludeTextField Object TXTextControl.LoadSettings Object TXTextControl.MergeField Object TXTextControl.NextField Object TXTextControl.NextIfField Object TXTextControl.Proofing Object TXTextControl.SaveSettings Object TXTextControl.TextField Object UserDictionaryInfo Object WebSocketClosedCallback Function WebSocketClosedEventArgs Object ZoomFactorChangedCallback Function ZoomFactorChangedEventArgs Object
- [Web API](https://docs.textcontrol.com/ds-server/reference/web-api/llms-full.txt): Every public endpoint of the DS Server Web API by group: DocumentProcessing, OAuth, Administration, Licensing and Authentication Server, with payloads.

---

## Nearby

- **Previous:** [What's New in DS Server 1.0](https://docs.textcontrol.com/ds-server/whats-new/0100/llms-full.txt)
- **Next:** [Web API](https://docs.textcontrol.com/ds-server/reference/web-api/llms-full.txt)
