Skip to content

Public Endpoint restructure (do not merge) #467

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.

Sign up for GitHub

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

Draft
muhsinking wants to merge 1 commit into
base: main
Choose a base branch
from
+400 −6
Draft

Public Endpoint restructure (do not merge) #467

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 50 additions & 6 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,6 +370,50 @@
}
]
},
{
"tab": "Public Endpoints",
"groups": [

{ "group": "Image models",
"pages": [
"public-endpoints/black-forest-labs-flux-1-dev",
"public-endpoints/black-forest-labs-flux-1-schnell",
"public-endpoints/black-forest-labs-flux-1-kontext-dev",
"public-endpoints/qwen-image-t2i",
"public-endpoints/qwen-image-t2i-lora",
"public-endpoints/qwen-image-edit",
"public-endpoints/seedream-v4-t2i",
"public-endpoints/seedream-v4-edit",
"public-endpoints/seedream-3-0-t2i",
"public-endpoints/nano-banana-edit"
]
},
{ "group": "Text models",
"pages": [
"public-endpoints/granite-4-0-h-small",
"public-endpoints/qwen3-32b-awq"
]
},
{
"group": "Video models",
"pages": [
"public-endpoints/infinitetalk",
"public-endpoints/kling-v2-1-i2v-pro",
"public-endpoints/seedance-1-0-pro",
"public-endpoints/sora-2-i2v",
"public-endpoints/sora-2-pro-i2v",
"public-endpoints/wan-2-5"
]
},
{
"group": "Audio models",
"pages": [
"public-endpoints/whisper-v3-large",
"public-endpoints/minimax-speech-02-hd"
]
}
]
},
{
"tab": "API",
"groups": [
Expand All @@ -378,7 +422,7 @@
"pages": [
"api-reference/overview",
{
"group": "pods",
"group": "Pods",
"pages": [
"api-reference/pods/POST/pods",
"api-reference/pods/GET/pods",
Expand All @@ -393,7 +437,7 @@
]
},
{
"group": "endpoints",
"group": "Endpoints",
"pages": [
"api-reference/endpoints/POST/endpoints",
"api-reference/endpoints/GET/endpoints",
Expand All @@ -404,7 +448,7 @@
]
},
{
"group": "network volumes",
"group": "Network volumes",
"pages": [
"api-reference/network-volumes/POST/networkvolumes",
"api-reference/network-volumes/GET/networkvolumes",
Expand All @@ -415,7 +459,7 @@
]
},
{
"group": "templates",
"group": "Templates",
"pages": [
"api-reference/templates/POST/templates",
"api-reference/templates/GET/templates",
Expand All @@ -426,7 +470,7 @@
]
},
{
"group": "container registry auth",
"group": "Container registry auth",
"pages": [
"api-reference/container-registry-auths/POST/containerregistryauth",
"api-reference/container-registry-auths/GET/containerregistryauth",
Expand All @@ -435,7 +479,7 @@
]
},
{
"group": "billing",
"group": "Billing",
"pages": [
"api-reference/billing/GET/billing/pods",
"api-reference/billing/GET/billing/endpoints",
Expand Down
105 changes: 105 additions & 0 deletions public-endpoints/black-forest-labs-flux-1-dev.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
---
title: "Flux Dev"
api: "POST https://api.runpod.ai/v2/black-forest-labs-flux-1-dev/run"
description: "Create high-quality, detailed images using the Flux Dev model"
playground: "simple"
---

Flux Dev is optimized for high-quality, detailed image generation. The model accepts several parameters to control the generation process, including prompt guidance, image dimensions, and sampling steps.

Each image generated costs \$0.02 per megapixel.

## Body

<ParamField body="input" type="object" required>
The input configuration object containing all generation parameters.

<Expandable title="input properties">
<ParamField body="prompt" type="string" required>
Text description of the desired image.
</ParamField>

<ParamField body="negative_prompt" type="string">
Elements to exclude from the image.
</ParamField>

<ParamField body="width" type="integer" default="1024">
Image width in pixels. Must be divisible by 64. Valid range: 256-1536.
</ParamField>

<ParamField body="height" type="integer" default="1024">
Image height in pixels. Must be divisible by 64. Valid range: 256-1536.
</ParamField>

<ParamField body="num_inference_steps" type="integer" default="28">
Number of denoising steps. Valid range: 1-50.
</ParamField>

<ParamField body="guidance" type="float" default="7">
How closely to follow the prompt. Valid range: `0.0`-`10.0`.
</ParamField>

<ParamField body="seed" type="integer" default="-1">
Provide a seed for reproducible results. The default value (`-1`) will generate a random seed.
</ParamField>

<ParamField body="image_format" type="string" default="jpeg">
Output image format. Options: `"png"` or `"jpeg"`.
</ParamField>
</Expandable>
</ParamField>


<ResponseExample>

```json Response
{
"delayTime": 17,
"executionTime": 3986,
"id": "sync-0965434e-ff63-4a1c-a9f9-5b705f66e176-u2",
"output": {
"cost": 0.02097152,
"image_url": "https://image.runpod.ai/6/6/mCwUZlep6S/453ad7b7-67c6-43a1-8348-3ad3428ef97a.png"
},
"status": "COMPLETED",
"workerId": "oqk7ao1uomckye"
}
```

</ResponseExample>

## Response

<ResponseField name="id" type="string">
Unique identifier for the job.
</ResponseField>

<ResponseField name="status" type="string">
Current status of the job. Value will be "COMPLETED" for successful synchronous requests.
</ResponseField>

<ResponseField name="delayTime" type="integer">
Time in milliseconds the job spent in queue before processing started.
</ResponseField>

<ResponseField name="executionTime" type="integer">
Time in milliseconds taken to process the request.
</ResponseField>

<ResponseField name="workerId" type="string">
Identifier of the worker that processed the request.
</ResponseField>

<ResponseField name="output" type="object">
Contains the generation results.

<Expandable title="output properties">
<ResponseField name="image_url" type="string">
URL of the generated image. The URL is valid for 7 days.
</ResponseField>

<ResponseField name="cost" type="float">
Cost in credits for this generation.
</ResponseField>
</Expandable>
</ResponseField>
Loading