reminix-openai 0.0.12

Reminix adapter for OpenAI - serve agents as REST APIs

reminix-openai

Reminix Runtime adapter for the OpenAI API. Serve OpenAI models as a REST API.

Ready to go live? Deploy to Reminix Cloud for zero-config hosting, or self-host on your own infrastructure.

Installation

pip install reminix-openai

This will also install reminix-runtime as a dependency.

Quick Start

from openai import AsyncOpenAI
from reminix_openai import serve_agent

client = AsyncOpenAI()
serve_agent(client, name="my-chatbot", model="gpt-4o", port=8080)

For more flexibility (e.g., serving multiple agents), use wrap_agent and serve separately:

from openai import AsyncOpenAI
from reminix_openai import wrap_agent
from reminix_runtime import serve

client = AsyncOpenAI()
agent = wrap_agent(client, name="my-chatbot", model="gpt-4o")
serve(agents=[agent], port=8080)

Your agent is now available at:

• POST /agents/my-chatbot/execute - Execute the agent

API Reference

serve_agent(client, name, model, port, host)

Wrap an OpenAI client and serve it immediately. Combines wrap_agent and serve for single-agent setups.

Parameter	Type	Default	Description
client	AsyncOpenAI	required	An OpenAI async client
name	str	"openai-agent"	Name for the agent (used in URL path)
model	str	"gpt-4o-mini"	Model to use for completions
port	int	8080	Port to serve on
host	str	"0.0.0.0"	Host to bind to

wrap_agent(client, name, model)

Wrap an OpenAI client for use with Reminix Runtime. Use this with serve from reminix_runtime for multi-agent setups.

Parameter	Type	Default	Description
client	AsyncOpenAI	required	An OpenAI async client
name	str	"openai-agent"	Name for the agent (used in URL path)
model	str	"gpt-4o-mini"	Model to use for completions

Returns: OpenAIAgentAdapter - A Reminix adapter instance

Example with Custom Configuration

from openai import AsyncOpenAI
from reminix_openai import wrap_agent
from reminix_runtime import serve

client = AsyncOpenAI(
    api_key="your-api-key",
    base_url="https://your-proxy.com/v1"  # Optional: custom endpoint
)

agent = wrap_agent(
    client,
    name="gpt4-agent",
    model="gpt-4o"
)

serve(agents=[agent], port=8080)

Endpoint Input/Output Formats

POST /agents/{name}/execute

Execute the agent with a prompt or messages.

Request with prompt:

{
  "prompt": "Summarize this text: ..."
}

Request with messages:

{
  "messages": [
    {"role": "system", "content": "You are a helpful assistant."},
    {"role": "user", "content": "Hello!"}
  ]
}

Response:

{
  "output": "Hello! How can I help you today?"
}

Streaming

For streaming responses, set stream: true in the request:

{
  "prompt": "Tell me a story",
  "stream": true
}

The response will be sent as Server-Sent Events (SSE).

Runtime Documentation

For information about the server, endpoints, request/response formats, and more, see the reminix-runtime package.

Deployment

Ready to go live?

• Deploy to Reminix Cloud - Zero-config cloud hosting
• Self-host - Run on your own infrastructure

Links

• GitHub Repository
• OpenAI Documentation

License

Apache-2.0