AI API Mapper

Prerequisites

An x86-64 or arm64 host
Docker Engine with the Compose v2 plugin
A user in the docker group (or sudo)
curl

Install

curl -fsSLO https://apimapper.ai/install/install.sh && bash install.sh

What happens next

Run the command above in a terminal window. It saves install.sh in the current folder and then runs it, so you can read the script first. To check it against the published checksum before running it (optional):
```
curl -fsSLO https://apimapper.ai/install/SHA256SUMS
grep ' install.sh$' SHA256SUMS | sha256sum -c -
```
Preflight. The installer checks Docker, Compose v2, the CPU architecture, free ports and disk space. A host that cannot run the platform stops here, before you have typed anything.
Registration. It asks for your company name, your full name, your email and, optionally, a phone number, then asks you to accept the evaluation license terms and the Coded Projects privacy statement. It shows a summary and asks you to confirm.
Docker Hub access. If this host cannot already pull the AI API Mapper images, the installer offers two choices: I have an access key, or Ask Coded Projects for an access key. Asking sends your registration, emails you a 6-digit code to confirm your address, and then we email your access key. When it arrives, run the same command again and choose I have an access key. The key is typed at a hidden prompt and never saved in a file.
Install. The installer pulls the images, requests your 30-day evaluation license, starts the platform and prints a summary with the install folder (docker-compose.yml, .env and license/), the license status and the Portal address.
Open the Portal at the address the summary prints, in a browser on this machine or your network.
Move to a commercial license when you have one. From the install folder, replace the evaluation license in place; the running platform picks it up within about 90 seconds:
```
bash install.sh update-license /path/to/license.json
```

Prerequisites

Apple silicon or Intel
Docker Desktop, running
The built-in bash and curl

Install

curl -fsSLO https://apimapper.ai/install/install.sh && bash install.sh

What happens next

Run the command above in a terminal window. It saves install.sh in the current folder and then runs it, so you can read the script first. To check it against the published checksum before running it (optional):
```
curl -fsSLO https://apimapper.ai/install/SHA256SUMS
grep ' install.sh$' SHA256SUMS | shasum -a 256 -c -
```
Preflight. The installer checks Docker, Compose v2, the CPU architecture, free ports and disk space. A host that cannot run the platform stops here, before you have typed anything.
Registration. It asks for your company name, your full name, your email and, optionally, a phone number, then asks you to accept the evaluation license terms and the Coded Projects privacy statement. It shows a summary and asks you to confirm.
Docker Hub access. If this host cannot already pull the AI API Mapper images, the installer offers two choices: I have an access key, or Ask Coded Projects for an access key. Asking sends your registration, emails you a 6-digit code to confirm your address, and then we email your access key. When it arrives, run the same command again and choose I have an access key. The key is typed at a hidden prompt and never saved in a file.
Install. The installer pulls the images, requests your 30-day evaluation license, starts the platform and prints a summary with the install folder (docker-compose.yml, .env and license/), the license status and the Portal address.
Open the Portal at the address the summary prints, in a browser on this machine or your network.
Move to a commercial license when you have one. From the install folder, replace the evaluation license in place; the running platform picks it up within about 90 seconds:
```
bash install.sh update-license /path/to/license.json
```

Prerequisites

Windows 10/11 or Windows Server with Docker Desktop (WSL 2 backend), running
PowerShell 7 (winget install Microsoft.PowerShell)

Install

Invoke-WebRequest https://apimapper.ai/install/install.ps1 -OutFile install.ps1; pwsh -ExecutionPolicy Bypass -File .\install.ps1

What happens next

Run the command above in a PowerShell window. It saves install.ps1 in the current folder and then runs it, so you can read the script first. To check it against the published checksum before running it (optional):
```
$expected = ((Invoke-RestMethod https://apimapper.ai/install/SHA256SUMS) -split "`n" | Where-Object { $_ -like '*install.ps1' }).Split(' ')[0]
(Get-FileHash .\install.ps1 -Algorithm SHA256).Hash -eq $expected
```
Preflight. The installer checks Docker, Compose v2, the CPU architecture, free ports and disk space. A host that cannot run the platform stops here, before you have typed anything.
Registration. It asks for your company name, your full name, your email and, optionally, a phone number, then asks you to accept the evaluation license terms and the Coded Projects privacy statement. It shows a summary and asks you to confirm.
Docker Hub access. If this host cannot already pull the AI API Mapper images, the installer offers two choices: I have an access key, or Ask Coded Projects for an access key. Asking sends your registration, emails you a 6-digit code to confirm your address, and then we email your access key. When it arrives, run the same command again and choose I have an access key. The key is typed at a hidden prompt and never saved in a file.
Install. The installer pulls the images, requests your 30-day evaluation license, starts the platform and prints a summary with the install folder (docker-compose.yml, .env and license/), the license status and the Portal address.
Open the Portal at the address the summary prints, in a browser on this machine or your network.
Move to a commercial license when you have one. From the install folder, replace the evaluation license in place; the running platform picks it up within about 90 seconds:
```
pwsh -ExecutionPolicy Bypass -File .\install.ps1 update-license C:\path\to\license.json
```

Install it on your own hostwith one command

Prerequisites

Install

What happens next

Prerequisites

Install

What happens next

Prerequisites

Install

What happens next

Install it on your own host
with one command