Getting Started

API Token

If you don’t already have an account navigate to the app.prodia.com and click Sign Up.

Note

You’ll need a Pro+ subscription in order to generate a v2 token. Make sure to upgrade your account to Pro+ if you haven’t already!

Go to the API Dashboard to generate a token. You should see a token management screen similar to this:

If the token management interface isn’t showing up please check that you have an active Pro+ subscription.

Give the token a meaningful label like getting started and click Create API Key:

Next copy the key to a safe location. We will use this key for the remainder of the tutorial.

Caution

Make sure to copy the API Key to a safe place (e.g. a password manager). The API Key will only be visible in the dashboard once.

Now that we have an API key were are ready to setup the project.

Project Setup

# Create a project directory.
mkdir prodia-getting-started
cd prodia-getting-started

prodia-js

Install Node (if not already installed):

macOS

brew install node
# Close the current terminal and open a new one so that node is available.

Linux

apt install node
# Close the current terminal and open a new one so that node is available.

Windows

winget install -e --id OpenJS.NodeJS.LTS
# Close the current terminal and open a new one so that node is available.

Create project skeleton:

# Requires node --version >= 18
# Initialize the project with npm.
npm init -y

# Install the prodia-js library.
npm install prodia --save

requests

Install Python (if not already installed):

macOS

brew install python
# Close the current terminal and open a new one so that python is available.

Linux

apt install python3 python3-venv python-is-python3
# Close the current terminal and open a new one so that python is available.

Windows

winget install -e --id Python.Python.3.12
# Close the current terminal and open a new one so that python is available.

# Requires python --version >= 3.12
python -m venv venv
source venv/bin/activate
pip install requests

curl

Install curl (if not already installed):

macOS

brew install curl
# Close the current terminal and open a new one so that curl is available.

Linux

apt install curl
# Close the current terminal and open a new one so that curl is available.

Windows

# NOTE: Windows 10 and up have curl installed by default and this can be
# skipped.
winget install -e --id cURL.cURL
# Close the current terminal and open a new one so that curl is available.

# Export your token so it can be used by the main code.
export PRODIA_TOKEN=your-token-here

Note

Your token is exported to an environment variable. If you close or switch your shell you’ll need to run export PRODIA_TOKEN=your-token-here again.

Create a main file for your project:

prodia-js

main.js

const { createProdia } = require("prodia/v2");

const prodia = createProdia({
    token: process.env.PRODIA_TOKEN // get it from environment
});

requests

Create the following main.py

main.py

from requests.adapters import HTTPAdapter, Retry
import os
import requests
import sys


prodia_token = os.getenv('PRODIA_TOKEN')
prodia_url = 'https://inference.prodia.com/v2/job'

session = requests.Session()
retries = Retry(status_forcelist=Retry.RETRY_AFTER_STATUS_CODES)
session.mount('http://', HTTPAdapter(max_retries=retries))
session.headers.update({'Authorization': f"Bearer {prodia_token}"})

curl

main.sh

set -euo pipefail

You’re now ready to make some API calls!

Text to Image

Add the following to the main file:

prodia-js

main.js

const fs = require("node:fs/promises");
const { createProdia } = require("prodia/v2");

const prodia = createProdia({
    token: process.env.PRODIA_TOKEN // get it from environment
});

(async () => {
    // run a flux dev generation
    const job = await prodia.job({
        type: "inference.flux.dev.txt2img.v1",
        config: {
            prompt: "puppies in a cloud, 4k",
        }
    });

    const image = await job.arrayBuffer();

    await fs.writeFile("puppies.jpg", new Uint8Array(image));
})();

requests

main.py

from requests.adapters import HTTPAdapter, Retry
import os
import requests
import sys


prodia_token = os.getenv('PRODIA_TOKEN')
prodia_url = 'https://inference.prodia.com/v2/job'

session = requests.Session()
retries = Retry(status_forcelist=Retry.RETRY_AFTER_STATUS_CODES)
session.mount('http://', HTTPAdapter(max_retries=retries))
session.headers.update({'Authorization': f"Bearer {prodia_token}"})

headers = {
    'Accept': 'image/png',
}

job = {
    'type': 'inference.flux.dev.txt2img.v1',
    'config': {
        'prompt': 'puppies in a cloud, 4k',
    },
}

res = session.post(prodia_url, headers=headers, json=job)
print(f"Request ID: {res.headers['x-request-id']}")
print(f"Status: {res.status_code}")

if res.status_code != 200:
    print(res.text)
    sys.exit(1)

with open('puppies.jpg', 'wb') as f:
    f.write(res.content)

curl

main.sh

set -euo pipefail

job=$(cat <<EOF
{
  "type": "inference.flux.dev.txt2img.v1",
  "config": {
    "prompt": "puppies in a cloud, 4k",
  }
}
EOF
)

curl -sSf \
  -H "Authorization: Bearer $PRODIA_TOKEN" \
  -H 'Accept: image/jpeg' \
  --json "$job" \
  --output puppies.jpg \
  --retry 3 \
  https://inference.prodia.com/v2/job

Run the main code:

prodia-js

node main.js

requests

python main.py

curl

bash main.sh

Open the output image puppies.jpg:

macOS

open puppies.jpg

Linux

xdg-open puppies.jpg

Windows

start puppies.jpg

And you’ll see some cute puppies like these:

Congratulations on finishing your first project using Prodia!