# Web API > All 25 methods of the ReportingCloud Web API at api.reporting.cloud/v1 in one table, with API key and Basic authentication, quotas, test runs and timeouts. - **Product:** ReportingCloud - **Section:** Documentation - **Kind:** Topic - **Path:** ReportingCloud > API Reference > Web API - **2440 words** - **Web URL:** https://docs.textcontrol.com/reporting-cloud/reference/web-api/ - **LLMs URL:** https://docs.textcontrol.com/reporting-cloud/reference/web-api/llms.txt - **LLMs-Full URL:** https://docs.textcontrol.com/reporting-cloud/reference/web-api/llms-full.txt --- The ReportingCloud Web API is a set of HTTPS endpoints that create documents from templates and data, manage the template storage and the account, list the available fonts, check spelling and process tracked changes. Each method has a page with its URL, the authorization it requires, its request parameters, the objects of its request payload, its success and error responses and examples of a call. The base URL of the Web API is `https://api.reporting.cloud/`, and every endpoint is below `/v1/`: the method pages give the full URL, such as `https://api.reporting.cloud/v1/document/merge`. The API accepts HTTPS requests only. ### Authentication and Quotas Every request carries an `Authorization` header with one of two credentials: an API key, written `ReportingCloud-APIKey` followed by a space and the key, or the user name and password of your account, written `Basic` followed by a space and the Base64 encoding of `username:password`. [Authentication](https://docs.textcontrol.com/reporting-cloud/document-processing/authentication/llms-full.txt) shows both with curl and the SDKs. Methods that create documents or thumbnails, check spelling or store templates count against a quota of your plan: the document quota, the spell checking quota or the template storage quota. The Description section of each method page says whether and how the method counts, and [Plans and Licensing](https://docs.textcontrol.com/reporting-cloud/overview/licensing/llms-full.txt) lists the quotas of each plan. Merge, append, convert and find and replace also take a `test` parameter: a test run is not counted and creates a document with a "TEST MODE" watermark, but Free accounts cannot use it. A trial account can, and there only the test runs of convert and append are not counted: a test run of merge or find and replace counts against the document quota. The methods that create documents or thumbnails limit the processing time of a request to 60 seconds. When a quota is used up or the credentials are not valid, the endpoint answers 403, and when the request cannot be processed, 400. A request without an `Authorization` header, or with an empty or malformed one, gets 500, a URL that matches no endpoint or leaves out a required query parameter 404, and another HTTP method than the documented one 405. A `POST` that has neither a body nor a `Content-Length` header gets 411, and one whose body has no `Content-Type` header, or one such as `text/plain`, gets 415. Too many requests at the same time from one IP address can get a 403 from the web server, with an HTML page instead of the plain-text message. [Errors and Status Codes](https://docs.textcontrol.com/reporting-cloud/document-processing/errors/llms-full.txt) explains them. ### All Methods | Method | Endpoint | Description | |---|---|---| | [`POST`](https://docs.textcontrol.com/reporting-cloud/reference/web-api/document/append/post/llms-full.txt) | [/v1/document/append](https://docs.textcontrol.com/reporting-cloud/reference/web-api/document/append/post/llms-full.txt) | Combines documents by appending them divided by a new section, paragraph or nothing. | | [`POST`](https://docs.textcontrol.com/reporting-cloud/reference/web-api/document/convert/post/llms-full.txt) | [/v1/document/convert](https://docs.textcontrol.com/reporting-cloud/reference/web-api/document/convert/post/llms-full.txt) | Converts a document to another supported format. | | [`POST`](https://docs.textcontrol.com/reporting-cloud/reference/web-api/document/findandreplace/post/llms-full.txt) | [/v1/document/findandreplace](https://docs.textcontrol.com/reporting-cloud/reference/web-api/document/findandreplace/post/llms-full.txt) | Executes a find and replace on a template to create a document. | | [`POST`](https://docs.textcontrol.com/reporting-cloud/reference/web-api/document/merge/post/llms-full.txt) | [/v1/document/merge](https://docs.textcontrol.com/reporting-cloud/reference/web-api/document/merge/post/llms-full.txt) | Merges and returns a compatible template from the template storage or an uploaded template with hierarchical JSON data. | | [`GET`](https://docs.textcontrol.com/reporting-cloud/reference/web-api/document/share/get/llms-full.txt) | [/v1/document/share](https://docs.textcontrol.com/reporting-cloud/reference/web-api/document/share/get/llms-full.txt) | Returns an encrypted document name that can be used in the viewer widget. | | [`POST`](https://docs.textcontrol.com/reporting-cloud/reference/web-api/document/thumbnails/post/llms-full.txt) | [/v1/document/thumbnails](https://docs.textcontrol.com/reporting-cloud/reference/web-api/document/thumbnails/post/llms-full.txt) | Creates and returns thumbnail images of documents. | | [`GET`](https://docs.textcontrol.com/reporting-cloud/reference/web-api/templates/count/get/llms-full.txt) | [/v1/templates/count](https://docs.textcontrol.com/reporting-cloud/reference/web-api/templates/count/get/llms-full.txt) | Returns the number of templates in the template storage. | | [`DELETE`](https://docs.textcontrol.com/reporting-cloud/reference/web-api/templates/delete/delete/llms-full.txt) | [/v1/templates/delete](https://docs.textcontrol.com/reporting-cloud/reference/web-api/templates/delete/delete/llms-full.txt) | Deletes a template from the ReportingCloud template storage. | | [`GET`](https://docs.textcontrol.com/reporting-cloud/reference/web-api/templates/download/get/llms-full.txt) | [/v1/templates/download](https://docs.textcontrol.com/reporting-cloud/reference/web-api/templates/download/get/llms-full.txt) | Returns the selected template from the storage. | | [`GET`](https://docs.textcontrol.com/reporting-cloud/reference/web-api/templates/exists/get/llms-full.txt) | [/v1/templates/exists](https://docs.textcontrol.com/reporting-cloud/reference/web-api/templates/exists/get/llms-full.txt) | Checks whether a template exists in the template storage. | | [`GET`](https://docs.textcontrol.com/reporting-cloud/reference/web-api/templates/info/get/llms-full.txt) | [/v1/templates/info](https://docs.textcontrol.com/reporting-cloud/reference/web-api/templates/info/get/llms-full.txt) | Returns information about the template including hierarchical structure of merge fields and merge blocks. | | [`GET`](https://docs.textcontrol.com/reporting-cloud/reference/web-api/templates/list/get/llms-full.txt) | [/v1/templates/list](https://docs.textcontrol.com/reporting-cloud/reference/web-api/templates/list/get/llms-full.txt) | Lists all templates from the ReportingCloud template storage. | | [`GET`](https://docs.textcontrol.com/reporting-cloud/reference/web-api/templates/pagecount/get/llms-full.txt) | [/v1/templates/pagecount](https://docs.textcontrol.com/reporting-cloud/reference/web-api/templates/pagecount/get/llms-full.txt) | Returns the number of pages of a template in the template storage. | | [`GET`](https://docs.textcontrol.com/reporting-cloud/reference/web-api/templates/thumbnails/get/llms-full.txt) | [/v1/templates/thumbnails](https://docs.textcontrol.com/reporting-cloud/reference/web-api/templates/thumbnails/get/llms-full.txt) | Creates and returns thumbnail images of template pages. | | [`POST`](https://docs.textcontrol.com/reporting-cloud/reference/web-api/templates/upload/post/llms-full.txt) | [/v1/templates/upload](https://docs.textcontrol.com/reporting-cloud/reference/web-api/templates/upload/post/llms-full.txt) | Stores an uploaded template in the ReportingCloud template storage. Supported template formats are Microsoft Word (.doc), WordProcessingML (.docx), Rich Text Format (.rtf) and TX Text Control Format (.tx). | | [`DELETE`](https://docs.textcontrol.com/reporting-cloud/reference/web-api/account/apikey/delete/llms-full.txt) | [/v1/account/apikey](https://docs.textcontrol.com/reporting-cloud/reference/web-api/account/apikey/delete/llms-full.txt) | Deletes a ReportingCloud API key from the list of existing API keys. | | [`PUT`](https://docs.textcontrol.com/reporting-cloud/reference/web-api/account/apikey/put/llms-full.txt) | [/v1/account/apikey](https://docs.textcontrol.com/reporting-cloud/reference/web-api/account/apikey/put/llms-full.txt) | Creates and stores a new ReportingCloud API key to the list of API keys. | | [`GET`](https://docs.textcontrol.com/reporting-cloud/reference/web-api/account/apikeys/get/llms-full.txt) | [/v1/account/apikeys](https://docs.textcontrol.com/reporting-cloud/reference/web-api/account/apikeys/get/llms-full.txt) | Lists all available ReportingCloud API keys from the existing keys. | | [`GET`](https://docs.textcontrol.com/reporting-cloud/reference/web-api/account/settings/get/llms-full.txt) | [/v1/account/settings](https://docs.textcontrol.com/reporting-cloud/reference/web-api/account/settings/get/llms-full.txt) | Returns detailed information about the account quota and general settings. | | [`GET`](https://docs.textcontrol.com/reporting-cloud/reference/web-api/fonts/list/get/llms-full.txt) | [/v1/fonts/list](https://docs.textcontrol.com/reporting-cloud/reference/web-api/fonts/list/get/llms-full.txt) | Returns a list of available fonts that can be used in templates, the fonts of Windows and many, but not all, Google Fonts. | | [`GET`](https://docs.textcontrol.com/reporting-cloud/reference/web-api/proofing/availabledictionaries/get/llms-full.txt) | [/v1/proofing/availabledictionaries](https://docs.textcontrol.com/reporting-cloud/reference/web-api/proofing/availabledictionaries/get/llms-full.txt) | Returns all available dictionaries for supported proofing languages. | | [`GET`](https://docs.textcontrol.com/reporting-cloud/reference/web-api/proofing/check/get/llms-full.txt) | [/v1/proofing/check](https://docs.textcontrol.com/reporting-cloud/reference/web-api/proofing/check/get/llms-full.txt) | Checks text for spelling errors. | | [`GET`](https://docs.textcontrol.com/reporting-cloud/reference/web-api/proofing/suggestions/get/llms-full.txt) | [/v1/proofing/suggestions](https://docs.textcontrol.com/reporting-cloud/reference/web-api/proofing/suggestions/get/llms-full.txt) | Returns suggestions for a misspelled word. | | [`POST`](https://docs.textcontrol.com/reporting-cloud/reference/web-api/processing/review-removetrackedchange/post/llms-full.txt) | [/v1/processing/review/removetrackedchange](https://docs.textcontrol.com/reporting-cloud/reference/web-api/processing/review-removetrackedchange/post/llms-full.txt) | Removes a specific tracked change and returns the resulting document. | | [`POST`](https://docs.textcontrol.com/reporting-cloud/reference/web-api/processing/review-trackedchanges/post/llms-full.txt) | [/v1/processing/review/trackedchanges](https://docs.textcontrol.com/reporting-cloud/reference/web-api/processing/review-trackedchanges/post/llms-full.txt) | Returns the tracked changes of a document. | The service also answers at the URLs of the groups, because of the way it routes requests: `GET /v1/fonts` returns what `GET /v1/fonts/list` does, `POST /v1/templates` and `DELETE /v1/templates` upload and delete as `/v1/templates/upload` and `/v1/templates/delete` do, and `GET /v1/templates` and `GET /v1/account` answer 500. No SDK uses these urls; call the documented URLs of the method pages. ### Pages in This Section - [Document](https://docs.textcontrol.com/reporting-cloud/reference/web-api/document/llms-full.txt): merge, append, convert, find and replace, thumbnails and sharing, below `/v1/document`. - [Templates](https://docs.textcontrol.com/reporting-cloud/reference/web-api/templates/llms-full.txt): the template storage, below `/v1/templates`. - [Account](https://docs.textcontrol.com/reporting-cloud/reference/web-api/account/llms-full.txt): API keys and account settings, below `/v1/account`. - [Fonts](https://docs.textcontrol.com/reporting-cloud/reference/web-api/fonts/llms-full.txt): the fonts templates can use, `/v1/fonts/list`. - [Proofing](https://docs.textcontrol.com/reporting-cloud/reference/web-api/proofing/llms-full.txt): spell checking, below `/v1/proofing`. - [Processing](https://docs.textcontrol.com/reporting-cloud/reference/web-api/processing/llms-full.txt): tracked changes, below `/v1/processing`. --- ## In This Section - [Account](https://docs.textcontrol.com/reporting-cloud/reference/web-api/account/llms-full.txt): Create, list and delete ReportingCloud API keys and read the serial number, subscription end date and document, template storage and spell checking quotas. - [Document](https://docs.textcontrol.com/reporting-cloud/reference/web-api/document/llms-full.txt): Merge templates with JSON data, append, convert and find and replace documents, create page thumbnails and share templates with the /v1/document endpoints. - [Fonts](https://docs.textcontrol.com/reporting-cloud/reference/web-api/fonts/llms-full.txt): List the fonts ReportingCloud templates can use, Windows fonts and many Google Fonts, with GET /v1/fonts/list or the ListFonts and getFontList SDK methods. - [Processing](https://docs.textcontrol.com/reporting-cloud/reference/web-api/processing/llms-full.txt): The /v1/processing/review endpoints return the tracked changes of an RTF, DOC, DOCX or TX document and accept or reject one by id, also from .NET and PHP. - [Proofing](https://docs.textcontrol.com/reporting-cloud/reference/web-api/proofing/llms-full.txt): Check text for misspelled words, get suggestions for a word and list the dictionaries with the /v1/proofing spell checking endpoints of ReportingCloud. - [Templates](https://docs.textcontrol.com/reporting-cloud/reference/web-api/templates/llms-full.txt): Nine /v1/templates methods for stored templates: upload DOC, DOCX, RTF or TX files, list, count, download or delete them, get merge fields and page images. --- ## Nearby - **Previous:** [API Reference](https://docs.textcontrol.com/reporting-cloud/reference/llms-full.txt) - **Next:** [Document](https://docs.textcontrol.com/reporting-cloud/reference/web-api/document/llms-full.txt)