# API Nodes

## API Nodes

API Nodes allow you to turn any custom Atlas workflow into a **callable API endpoint**.\
They define how data enters and leaves a graph when exporting an API via the **API From Graph** feature.

Use these nodes whenever you want to:

* Deploy a workflow as a REST API
* Trigger Atlas processes programmatically
* Integrate Atlas with external tools (Unity, Blender, n8n, Flask, Unreal Engine, etc.)

### Overview <a href="#overview" id="overview"></a>

There are two categories of API Nodes:

1. **Input API Nodes** — define what data your external request can send into the workflow.
2. **Output API Nodes** — define what the workflow returns after execution.

Once these nodes are placed, the workflow can be exported as an API directly from the toolbar.

### Input API Nodes <a href="#api-input-nodes" id="api-input-nodes"></a>

Input API Nodes replace native inputs so that external applications can provide data through the API.

#### Available Input Types <a href="#available-input-types" id="available-input-types"></a>

* **API Input Text** – accepts string data
* &#x20;**API** **Input Number**– accepts numeric values
* &#x20;**API** **Input Boolean**– accepts true/false flags
* &#x20;**API Input Image** – accepts image file uploads
* **API  Input Mesh** – accepts mesh files (GLB, OBJ)

Use these nodes when preparing your graph for external execution.

<figure><img src="https://3654894688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FR7boiMixMhR4q36Ns33Y%2Fuploads%2FweuAZgFMGhuromKEYJAs%2Fimage.png?alt=media&#x26;token=cb39a2e7-8944-4415-b64a-70f63b95a5a0" alt="" width="563"><figcaption></figcaption></figure>

### Output API Nodes <a href="#api-output-nodes" id="api-output-nodes"></a>

API Output Nodes define what the API returns when the workflow completes.

#### Available Output Types <a href="#available-output-types" id="available-output-types"></a>

* &#x20;**API** **Output Text**– returns text strings
* &#x20;**API** **Output Number**– returns numeric values
* &#x20;**API** **Output Boolean**– returns true/false results
* &#x20;**API Output Image** – returns generated images
* **API** **Output Mesh**– returns mesh files
* &#x20;**API Output SVG** – returns vector graphics

Replace the final node’s output with the corresponding API Output Node to expose your result.

<figure><img src="https://3654894688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FR7boiMixMhR4q36Ns33Y%2Fuploads%2FEFHHbEq8UOwJSpGrxheG%2Fimage.png?alt=media&#x26;token=97c036aa-3edb-4f53-be4b-721be8bbd1eb" alt="" width="563"><figcaption></figcaption></figure>

### Exporting Your Custom Workflow as an API <a href="#exporting-your-custom-workflow-as-an-api" id="exporting-your-custom-workflow-as-an-api"></a>

<figure><img src="https://3654894688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FR7boiMixMhR4q36Ns33Y%2Fuploads%2F7BO34oHIGOGDDgwnd0mQ%2Fimage.png?alt=media&#x26;token=f10d4979-f176-48c3-8586-6f6d51709f17" alt="" width="563"><figcaption></figcaption></figure>

After setting the inputs and outputs with API Nodes, you can export your workflow as an API:

#### Steps <a href="#steps" id="steps"></a>

1. Build your workflow as usual.
2. Replace **all required inputs** in your workflow with the corresponding **Input API Nodes**.
3. **Add** an Output API Node and connect it to your final output node to expose the result through the API.
4. Click the **Export API** icon in the toolbar.
5. Enter a name for your API.
6. Click **Create**.

<figure><img src="https://3654894688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FR7boiMixMhR4q36Ns33Y%2Fuploads%2FFHQWmsAv1GVNKBO70tMM%2Fimage.png?alt=media&#x26;token=2371bd45-4124-4628-9cf1-6af6b38ab713" alt="" width="563"><figcaption></figcaption></figure>

The platform then generates:

* **Bash example**
* **Python example**
* **Full API JSON specification**
* **Your API ID**

These can be used immediately to call your workflow programmatically.

<figure><img src="https://3654894688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FR7boiMixMhR4q36Ns33Y%2Fuploads%2FueyoGQ18gzovz0HVsUiY%2Fimage.png?alt=media&#x26;token=1b4a3e08-dd05-430c-9de0-82bd0bea62bc" alt="" width="563"><figcaption></figcaption></figure>

### Using the Generated API <a href="#using-the-generated-api" id="using-the-generated-api"></a>

Once created, the API can be called from any environment:

* Python scripts
* Bash / curl
* Web backends
* Unity or Unreal Engine tools
* n8n or automation pipelines
* Blender scripts
* Custom UIs

Your API ID ensures that the workflow is executed with the exact graph and nodes you configured.