Skip to main content

metorial-openai-compatible

OpenAI-compatible provider integration for Metorial. Works with any API that follows the OpenAI chat completions format.

Installation

pip install metorial openai

Quick Start

import asyncio
from metorial import Metorial, MetorialOpenAICompatible
from openai import AsyncOpenAI

metorial = Metorial(api_key="your-metorial-api-key")

# Works with any OpenAI-compatible API
client = AsyncOpenAI(
    api_key="your-api-key",
    base_url="https://your-api-endpoint.com/v1"
)

async def main():
    async def session_handler(session):
        messages = [{"role": "user", "content": "What's the latest news?"}]

        for _ in range(10):
            response = await client.chat.completions.create(
                model="your-model",
                messages=messages,
                tools=session["tools"]
            )

            choice = response.choices[0]
            tool_calls = choice.message.tool_calls

            if not tool_calls:
                print(choice.message.content)
                break

            tool_responses = await session["callTools"](tool_calls)
            messages.append({"role": "assistant", "tool_calls": tool_calls})
            messages.extend(tool_responses)

        await session["closeSession"]()

    await metorial.with_provider_session(
        MetorialOpenAICompatible.chat_completions,
        {"serverDeployments": [{"serverDeploymentId": "your-server-deployment-id"}]},
        session_handler
    )

asyncio.run(main())

Streaming

import asyncio
from metorial import Metorial, MetorialOpenAICompatible
from openai import AsyncOpenAI

metorial = Metorial(api_key="your-metorial-api-key")
client = AsyncOpenAI(
    api_key="your-api-key",
    base_url="https://your-api-endpoint.com/v1"
)

async def main():
    async def session_handler(session):
        messages = [{"role": "user", "content": "What's the latest news?"}]

        stream = await client.chat.completions.create(
            model="your-model",
            messages=messages,
            tools=session["tools"],
            stream=True
        )

        async for chunk in stream:
            if chunk.choices[0].delta.content:
                print(chunk.choices[0].delta.content, end="", flush=True)

        await session["closeSession"]()

    await metorial.with_provider_session(
        MetorialOpenAICompatible.chat_completions,
        {
            "serverDeployments": [{"serverDeploymentId": "your-server-deployment-id"}],
            "streaming": True,  # Required for streaming with tool calls
        },
        session_handler
    )

asyncio.run(main())

Compatible Providers

Any provider with an OpenAI-compatible API:

  • DeepSeek (https://api.deepseek.com)
  • Together AI (https://api.together.xyz/v1)
  • XAI (https://api.x.ai/v1)
  • Groq (https://api.groq.com/openai/v1)
  • And many more...

Session Object

async def session_handler(session):
    tools = session["tools"]           # Tool definitions in OpenAI format
    call_tools = session["callTools"]  # Execute tools and get responses
    close_session = session["closeSession"]  # Close the session when done

Error Handling

from metorial import MetorialAPIError

try:
    await metorial.with_provider_session(...)
except MetorialAPIError as e:
    print(f"API Error: {e.message} (Status: {e.status})")
except Exception as e:
    print(f"Unexpected error: {e}")

License

MIT License - see LICENSE file for details.

Metadata

Release files for metorial-openai-compatible 1.0.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for metorial-openai-compatible 1.0.5
File Size Uploaded
metorial_openai_compatible-1.0.5.tar.gz 6.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for metorial-openai-compatible 1.0.5
File Interpreter ABI Platform
metorial_openai_compatible-1.0.5-py3-none-any.whl Python 3 none any Details

Total release size: 11.5 kB

Release files / metorial_openai_compatible-1.0.5.tar.gz

Download URL metorial_openai_compatible-1.0.5.tar.gz
Size 6.2 kB
Tags Source
SHA-256 checksum
How to use checksums
c9301e7ebfde8213baf5c167eb96bbfc46dc1bf0c46e0d8e433572404a043fdf
BLAKE2b-256 checksum
How to use checksums
4ae3182f8ddf052438a29d2c45021b8c26f57471a4a3598296bfdd6bc1231338
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Dec 23, 2025.

Transparency log

Release files / metorial_openai_compatible-1.0.5-py3-none-any.whl

Download URL metorial_openai_compatible-1.0.5-py3-none-any.whl
Size 5.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2e09deb1222685bb1107054c4d96db1c96260f7c368d3209e5cb4b2e08f71e7c
BLAKE2b-256 checksum
How to use checksums
4de6496023bc0affe30ce20e9d38401c00e5dab31ee6bbaa3b9d0757f6c33272
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Dec 23, 2025.

Transparency log
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page