Text to image generation with Stable Diffusion 3.0 · Routes on Ouro

11mo

Route documentation

Learn how to interact with this route using the Ouro SDK or REST API.

API access requires an API key. Create one in Settings → API Keys, then set OURO_API_KEY in your environment.

Request format

Parameters and request body schema for this route.

Request body

prompt

stringRequired

What you wish to see in the output image. A strong, descriptive prompt that clearly defines elements, colors, and subjects will lead to better results.

aspect_ratio

stringDefaults to 1:1

1:1

16:9

21:9

2:3

3:2

4:5

5:4

9:16

9:21

Controls the aspect ratio of the generated image.

negative_prompt

A blurb of text describing what you do not wish to see in the output image.

Retrieve route

Get route metadata including name, visibility, description, and endpoint details. You can retrieve by route ID or identifier.

import os
from ouro import Ouro
 
# Set OURO_API_KEY in your environment or replace os.environ.get("OURO_API_KEY")
ouro = Ouro(api_key=os.environ.get("OURO_API_KEY"))
 
# Option 1: Retrieve by route ID
route_id = "4c4e0f85-50bc-49ce-9cca-7cb4fd05e95c"
route = ouro.routes.retrieve(route_id)
 
# Option 2: Retrieve by route identifier (username/route-name)
route_identifier = "mmoderwell/text-to-image-generation-with-stable-diffusion-30"
route = ouro.routes.retrieve(route_identifier)
 
print(route.name, route.visibility)
print(route.metadata)

Use route

Execute the route endpoint with request body, query parameters, or path parameters.

# Retrieve the route
route = ouro.routes.retrieve("mmoderwell/text-to-image-generation-with-stable-diffusion-30")
 
# Use the route with a request body
response = route.use(
    body={
        'prompt': 'example_string',
        'aspect_ratio': '1:1'
    }
)
print(response)

Read actions

Get the request and response history for this route. Actions are especially useful for long-running routes where you can poll the status and retrieve the response when ready.

# Retrieve the route
route = ouro.routes.retrieve("mmoderwell/text-to-image-generation-with-stable-diffusion-30")
 
# Read all actions (request/response history) for this route
actions = route.read_actions()
print(actions)
 
# Actions are especially useful for long-running routes
# You can poll the status and retrieve the response when ready
for action in actions:
    print(f"Action ID: {action['id']}")
    print(f"Status: {action['status']}")
    print(f"Response: {action.get('response_data')}")

Route documentation

Learn how to interact with this route using the Ouro SDK or REST API.

API access requires an API key. Create one in Settings → API Keys, then set OURO_API_KEY in your environment.

Request format

Parameters and request body schema for this route.

Request body

prompt

stringRequired

What you wish to see in the output image. A strong, descriptive prompt that clearly defines elements, colors, and subjects will lead to better results.

aspect_ratio

stringDefaults to 1:1

1:1

16:9

21:9

2:3

3:2

4:5

5:4

9:16

9:21

Controls the aspect ratio of the generated image.

negative_prompt

A blurb of text describing what you do not wish to see in the output image.

Retrieve route

Get route metadata including name, visibility, description, and endpoint details. You can retrieve by route ID or identifier.

import os
from ouro import Ouro
 
# Set OURO_API_KEY in your environment or replace os.environ.get("OURO_API_KEY")
ouro = Ouro(api_key=os.environ.get("OURO_API_KEY"))
 
# Option 1: Retrieve by route ID
route_id = "4c4e0f85-50bc-49ce-9cca-7cb4fd05e95c"
route = ouro.routes.retrieve(route_id)
 
# Option 2: Retrieve by route identifier (username/route-name)
route_identifier = "mmoderwell/text-to-image-generation-with-stable-diffusion-30"
route = ouro.routes.retrieve(route_identifier)
 
print(route.name, route.visibility)
print(route.metadata)

Use route

Execute the route endpoint with request body, query parameters, or path parameters.

# Retrieve the route
route = ouro.routes.retrieve("mmoderwell/text-to-image-generation-with-stable-diffusion-30")
 
# Use the route with a request body
response = route.use(
    body={
        'prompt': 'example_string',
        'aspect_ratio': '1:1'
    }
)
print(response)

Read actions

Get the request and response history for this route. Actions are especially useful for long-running routes where you can poll the status and retrieve the response when ready.

# Retrieve the route
route = ouro.routes.retrieve("mmoderwell/text-to-image-generation-with-stable-diffusion-30")
 
# Read all actions (request/response history) for this route
actions = route.read_actions()
print(actions)
 
# Actions are especially useful for long-running routes
# You can poll the status and retrieve the response when ready
for action in actions:
    print(f"Action ID: {action['id']}")
    print(f"Status: {action['status']}")
    print(f"Response: {action.get('response_data')}")

services

services

Route documentation

Request format

Request body

prompt

aspect_ratio

negative_prompt

Retrieve route

Use route

Read actions

Route documentation

Request format

Request body

prompt

aspect_ratio

negative_prompt

Retrieve route

Use route

Read actions

Text to image generation with Stable Diffusion 3.0