--- title: "API Reference" slug: "api-reference" tags: ["data-integration", "api"] updated: 2026-09-14T17:35:04Z published: 2026-09-14T17:35:04Z canonical: "docs.unqork.io/api-reference" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.unqork.io/llms.txt > Use this file to discover all available pages before exploring further. # API Reference The API Reference covers general concepts for working with APIs in the Unqork Module Builder. Components like the [Plug-In component](/unqorkai/docs/plug-in-component) and [Initializer component](/unqorkai/docs/initializer-component) use these concepts to send and receive data from external and internal services. An is a connection between systems that lets them exchange data. In Unqork, API calls are typically configured using the Plug-In component. The component sends data from module fields to an external or internal API endpoint, then maps the response back into the module. A complete API call requires: - **Service**: The API endpoint to call—either a built-in Unqork internal service or an external service configured in [Services Administration](/unqorkai/docs/services-administration). - **Request Type**: The HTTP method that determines what action the API performs. - **Inputs**: Module field values sent to the API as parameters. - **Outputs**: Response values mapped back into module fields. ## HTTP Request Types The **Request Type** setting on the Plug-In component sets the HTTP method used for the API call. Each method defines a different intended action on the target resource. | Request Type | Description | | --- | --- | | | Retrieves data from the API without modifying it. Use for read-only operations. | | **POST** | Sends data to the API to create a new resource. | | | Sends data to the API to fully replace an existing resource. | | **PATCH** | Sends data to the API to partially update an existing resource. | | **DELETE** | Removes a resource from the API. | > [!NOTE] > The Inputs table is only available when **Request Type** is set to **POST**, **PATCH**, or **PUT**, because these methods include a request body. **GET** and **DELETE** requests do not send a body. ## Unqork API Documentation Unqork exposes its full API through a Swagger interface. Browse all available endpoints, read their documentation, and test calls directly in the browser. **Access the Unqork API Documentation**: Navigate to the Unqork environment URL and add `/#/apidocs` to the end. > An Unqork account is required to access the API documentation. Once logged in, authenticate the session and use the built-in testing tool to make live API calls. ### Using the Built-In Testing Tool Swagger's built-in testing tool lets Creators send real API requests without writing any code. To test an endpoint: 1. Navigate to the environment's API documentation (`/#/apidocs`) and log in with Unqork credentials. 2. Find the endpoint to test and click it to expand it. 3. Click **Try it out**. 4. Fill in any required parameters using the environment's data. 5. Click **Execute** to send the request. 6. Review the response body, status code, and headers returned below. --- **Changelog** | Date | Change | | --- | --- | | — | Initial publication. | APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. A definition An API endpoint is the location where an API receives requests for a specific resource on its server. It's the point of contact between an API client and an API server, and is usually a uniform resource locator (URL) that provides the location of the resource. HTTP (Hypertext Transfer Protocol) is an application-layer protocol used to transmit hypermedia documents like HTML. Enter inputs components and actions you want the component to perform.. Enter outputs components and actions you want the component to perform. The HTTP POST method is used to send data to a server to create or update a resource, typically including the data in the body of the request. Enter inputs components and actions you want the component to perform. An API endpoint is the location where an API receives requests for a specific resource on its server. It's the point of contact between an API client and an API server, and is usually a uniform resource locator (URL) that provides the location of the resource. A URL (uniform resource locator) is a unique identifier used to locate a resource on the internet. Also known as a web address. Also known as Unqork Users, or Designer Users; is anyone who is inside the Unqork platform.