Skip to main content

Reminix adapter for OpenAI - serve agents as REST APIs

Project description

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 wrap_and_serve

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

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

from openai import AsyncOpenAI
from reminix_openai import wrap
from reminix_runtime import serve

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

Your agent is now available at:

  • POST /agents/my-chatbot/invoke - Stateless invocation
  • POST /agents/my-chatbot/chat - Conversational chat

API Reference

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

Wrap an OpenAI client and serve it immediately. Combines wrap 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(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: OpenAIAdapter - A Reminix adapter instance

Example with Custom Configuration

from openai import AsyncOpenAI
from reminix_openai import wrap
from reminix_runtime import serve

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

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

serve([agent], port=8080)

Endpoint Input/Output Formats

POST /agents/{name}/invoke

Stateless invocation for task-oriented operations.

Request:

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

Or with messages:

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

Response:

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

POST /agents/{name}/chat

Conversational chat with message history.

Request:

{
  "messages": [
    {"role": "user", "content": "What is the capital of France?"}
  ]
}

Response:

{
  "output": "The capital of France is Paris.",
  "messages": [
    {"role": "user", "content": "What is the capital of France?"},
    {"role": "assistant", "content": "The capital of France is Paris."}
  ]
}

Runtime Documentation

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

Deployment

Ready to go live?

Links

License

Apache-2.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

reminix_openai-0.0.4.tar.gz (10.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

reminix_openai-0.0.4-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

File details

Details for the file reminix_openai-0.0.4.tar.gz.

File metadata

  • Download URL: reminix_openai-0.0.4.tar.gz
  • Upload date:
  • Size: 10.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.26 {"installer":{"name":"uv","version":"0.9.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for reminix_openai-0.0.4.tar.gz
Algorithm Hash digest
SHA256 3567d407b5bfbacc0aaca683bf3e2f3ffc4cee6ce4bf42593ce0f9befd56cf8e
MD5 ad786d77589e822d4da27fd02534ab22
BLAKE2b-256 a2b689ccde578d2ad0869bcf2be43d186208b66f9b691553e19ee9a8c8bf3667

See more details on using hashes here.

File details

Details for the file reminix_openai-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: reminix_openai-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 9.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.26 {"installer":{"name":"uv","version":"0.9.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for reminix_openai-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 12908c0acf713aa22375111faaf2508e57cd5df5ee424b7313bdd233265311bb
MD5 94174bed124f3ab198b7bad08602b604
BLAKE2b-256 cad26c65d01e8522bd84db51dfeaa6f66c423a11e0e54fd6d5b7e6d9c06ff32f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page