ogx-api
API and Provider specifications for OGX - a lightweight package with protocol definitions and provider specs.
Overview
ogx-api is a minimal dependency package that contains:
- API Protocol Definitions: Type-safe protocol definitions for OGX APIs (inference, agents, responses, etc.)
- Provider Specifications: Provider spec definitions for building custom providers
- Data Types: Shared data types and models used across the OGX ecosystem
- Type Utilities: Strong typing utilities and schema validation
What This Package Does NOT Include
- Server implementation (see
ogxpackage) - Provider implementations (see
ogxpackage) - CLI tools (see
ogxpackage) - Runtime orchestration (see
ogxpackage)
Use Cases
This package is designed for:
- Third-party Provider Developers: Build custom providers without depending on the full OGX server
- Client Library Authors: Use type definitions without server dependencies
- Documentation Generation: Generate API docs from protocol definitions
- Type Checking: Validate implementations against the official specs
Installation
pip install ogx-api
Or with uv:
uv pip install ogx-api
Dependencies
Minimal dependencies:
openai>=2.5.0- For OpenAI-compatible typesfastapi>=0.115.0,<1.0- For FastAPI route definitionspydantic>=2.11.9- For data validation and serializationjsonschema- For JSON schema utilitiesopentelemetry-sdk>=1.30.0- For telemetryopentelemetry-exporter-otlp-proto-http>=1.30.0- For OTLP export
Versioning
This package follows semantic versioning independently from the main ogx package:
- Patch versions (0.1.x): Documentation, internal improvements
- Minor versions (0.x.0): New APIs, backward-compatible changes
- Major versions (x.0.0): Breaking changes to existing APIs
The version is determined dynamically via setuptools-scm at build time.
Usage Example
from ogx_api import (
Api,
Inference,
InlineProviderSpec,
OpenAIChatCompletionRequestWithExtraBody,
)
# Use protocol definitions for type checking
class MyInferenceProvider(Inference):
async def openai_chat_completion(
self, request: OpenAIChatCompletionRequestWithExtraBody
):
# Your implementation
pass
# Define provider specifications
my_provider_spec = InlineProviderSpec(
api=Api.inference,
provider_type="inline::my-provider",
pip_packages=["my-dependencies"],
module="my_package.providers.inference",
config_class="my_package.providers.inference.MyConfig",
)
Relationship to ogx
The main ogx package depends on ogx-api and provides:
- Full server implementation
- Built-in provider implementations
- CLI tools for running and managing stacks
- Runtime provider resolution and orchestration
Contributing
See the main OGX repository for contribution guidelines.
License
MIT License - see LICENSE file for details.
Links
4 maintainers
Metadata
4 maintainers
Release files for ogx-api 1.4.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| ogx_api-1.4.1.tar.gz | 168.5 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ogx_api-1.4.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 337.7 kB
Release files / ogx_api-1.4.1.tar.gz
| Download URL | ogx_api-1.4.1.tar.gz |
|---|---|
| Size | 168.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9f9d733d5d0fe7c934e238db62fbe1967d51c6ca1cb27873dd8d6e9b470fa05e
|
|
BLAKE2b-256 checksum How to use checksums |
6ec20cf92b3fde25543d785d68f4d3fe72189a71816e5cd42d6fa5ba12fd10f3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
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 Oct 19, 2026.
Transparency logRelease files / ogx_api-1.4.1-py3-none-any.whl
| Download URL | ogx_api-1.4.1-py3-none-any.whl |
|---|---|
| Size | 169.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b2ec990afc7a96e8ee6261ac6924466d8bb33a062e4d42d2047fe31ba3d5c495
|
|
BLAKE2b-256 checksum How to use checksums |
331cde5eb09151a5d9cc63622a8db1c30b70c66b8353af6a878282b5037eeac4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
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 Oct 19, 2026.
Transparency logSecurity for ogx-api 1.4.1
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.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for ogx_api-1.4.1.tar.gz
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 Oct 19, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
