Skip to content

feat: Public endpoints documentation #280

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Conversation

muhsinking
Copy link
Collaborator

@muhsinking muhsinking commented Jun 6, 2025

Created a guide for the new public endpoints feature, explaining:

  • Available models
  • How to access/use the playground
  • How to make API requests
  • Model-specific params
  • Pricing
  • Best practices

Comment on lines +127 to +128
"message": "Image generated successfully",
"status": "success"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed these output.

"id": "sync-0965434e-ff63-4a1c-a9f9-5b705f66e176-u2",
"output": {
"cost": 0.02097152,
"image_url": "https://image.runpod.ai/gen-images/6/6/mCwUZlep6S/453ad7b7-67c6-43a1-8348-3ad3428ef97a.png",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the path changed, we removed 'gen-images'

{
    "delayTime": 498,
    "executionTime": 5228,
    "id": "sync-7705df5f-6e8c-43b6-9fe8-98b1047b8b88-u1",
    "output": {
        "cost": 0.02097152,
        "image_url": "https://image.runpod.ai/6/11/G8R_FQyxlR/166a1d80-327f-4167-9ba5-f5af63ecfff5.png"
    },
    "status": "COMPLETED",
    "workerId": "xv8jowx5ctaix9"
}

"width": 1024,
"height": 1024,
"num_inference_steps": 50,
"guidance": 8.0
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe we should add seed: -1
that means random

**Parameters:**
- `prompt` (string, required): Text description of the desired image.
- `negative_prompt` (string, optional): Elements to exclude from the image.
- `width` (integer, default: 1024): Image width in pixels (64-2048).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for width and height, the limit is 256 - 1536

- `width` (integer, default: 1024): Image width in pixels (64-2048).
- `height` (integer, default: 1024): Image height in pixels (64-2048).
- `num_inference_steps` (integer, default: 20): Number of denoising steps (1-50).
- `guidance` (float, default: 7.5): How closely to follow the prompt (1.0-20.0).
Copy link
Collaborator

@Yhlong00 Yhlong00 Jun 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

0 - 10.0

- `negative_prompt` (string, optional): Elements to exclude from the image.
- `width` (integer, default: 1024): Image width in pixels (64-2048).
- `height` (integer, default: 1024): Image height in pixels (64-2048).
- `num_inference_steps` (integer, default: 20): Number of denoising steps (1-50).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

default 28

```

**Parameters:**
- `prompt` (string, required): Text description of the desired image.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

negative prompt

Comment on lines +187 to +188
- `width` (integer, default: 1024): Image width in pixels (64-2048).
- `height` (integer, default: 1024): Image height in pixels (64-2048).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same as above

- `height` (integer, default: 1024): Image height in pixels (64-2048).
- `num_inference_steps` (integer, default: 4): Number of denoising steps (1-8).
- `guidance` (float, default: 1.0): Prompt adherence strength (0.5-2.0).
- `seed` (integer, optional): Random seed for reproducible results.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

default -1, means random

- `width` (integer, default: 1024): Image width in pixels (64-2048).
- `height` (integer, default: 1024): Image height in pixels (64-2048).
- `num_inference_steps` (integer, default: 4): Number of denoising steps (1-8).
- `guidance` (float, default: 1.0): Prompt adherence strength (0.5-2.0).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

0 - 10

| Model | Price | Billing unit |
|-------|-------|--------------|
| Flux Dev | $0.02 | Per megapixel |
| Flux Schnell | $0.00024 | Per megapixel |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

0.0024

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

HAHA ok I copied this from someone else's slack message but I did think this was kinda low

Comment on lines +227 to +231
**Pricing examples:**
- 512×512 image (0.25 megapixels): \$0.005 (Flux Dev) / \$0.00006 (Flux Schnell)
- 1024×1024 image (1 megapixel): \$0.02 (Flux Dev) / \$0.00024 (Flux Schnell)
- 2048×2048 image (4 megapixels): \$0.08 (Flux Dev) / \$0.00096 (Flux Schnell)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove 2048 x 2048

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants