Skip to content

api.md

Latest commit

 

History

History
172 lines (121 loc) · 5.87 KB

api.md

File metadata and controls

172 lines (121 loc) · 5.87 KB
Raw

API (meta-package)

This page documents the API exported by abstractframework, the meta-package shipped by this repository.

abstractframework is a pinned distribution profile plus a few lightweight helpers. AbstractFramework has two entrypoints: AbstractCore (LLM SDK + optional OpenAI-compatible /v1 server) and AbstractGateway (durable run control plane over HTTP/SSE). Most functional APIs live in component packages — especially AbstractCore for the LLM SDK.

Install

Full pinned ecosystem:

pip install abstractframework

Only the LLM SDK:

pip install abstractcore

Hardware-specific profiles (native installs, not Docker):

pip install "abstractframework[apple]"       # Apple Silicon native stack (MLX/Metal)
pip install "abstractframework[gpu]"         # GPU native stack (CUDA/ROCm)

See Install AbstractFramework for the profile chooser and first health checks.

Convenience re-exports

abstractframework re-exports two common AbstractCore entry points so simple scripts can from abstractframework import ... without a separate abstractcore import.

create_llm

from abstractframework import create_llm

llm = create_llm("ollama", model="qwen3:4b-instruct")
resp = llm.generate("hello")
print(resp.content)

GenerateResponse

The response type returned by llm.generate(...).

Release profile helpers

RELEASE_VERSIONS

Dictionary mapping each ecosystem package name to the pinned version for this release.

CORE_DEFAULT_EXTRAS

List of AbstractCore extras implied by the default framework install profile (remote-first): remote, tools, media, vision, voice, audio, music.

get_release_profile()

Returns the full pinned profile metadata as a dict.

from abstractframework import get_release_profile

profile = get_release_profile()
print(profile["abstractframework"])        # meta-package version
print(profile["packages"]["abstractcore"]) # pinned Core version

get_installed_packages()

Returns a dict of installed AbstractFramework package versions detected in the current environment.

from abstractframework import get_installed_packages
print(get_installed_packages())

print_status()

Prints a human-readable status report of detected packages (installed vs missing).

from abstractframework import print_status
print_status()

abstractframework doctor

Checks Python version, pinned package versions, Node/npm availability for browser UIs, and local hardware indicators for Apple/GPU profiles. It does not import heavy local inference stacks.

abstractframework doctor
abstractframework doctor --json

abstractframework manifest

Prints or validates the installer-facing manifest generated from the root release profile.

abstractframework manifest
abstractframework manifest --check docs/installers/install-manifest.json

Where to find the functional APIs

What you need Package
LLM calls, tools, structured output, media, embeddings, MCP abstractcore
Durable execution kernel (runs, ledger, effects, waits) abstractruntime
Agent patterns (ReAct, CodeAct, MemAct) abstractagent
Control plane (HTTP server, scheduling, bundle discovery, SSE) abstractgateway
Workflow authoring UI @abstractframework/flow (npm)
Monitoring / operations UI @abstractframework/observer (npm)

See Getting Started for the two entry points and a first end-to-end run.

Gateway-hosted workflow APIs distinguish private runtime bundles from the shared workflow catalog:

  • /api/gateway/bundles remains the caller runtime's private bundle surface.
  • /api/gateway/workflow-catalog lists catalog workflows visible to the signed in principal.
  • /api/gateway/admin/workflow-catalog/* is admin-only for immutable catalog upload/promote/default/ACL/status operations.
  • /api/gateway/runs/start and /api/gateway/runs/schedule accept registry_scope: "tenant_catalog" to start a catalog workflow in the requesting user's runtime.
  • Catalog scope is explicit. Without registry_scope, Gateway starts only private runtime bundles. Catalog flow/schema inspection uses ACL-aware /api/gateway/workflow-catalog/{bundle_id}/versions/{version}/flows/{flow_id} routes.

Gateway-hosted user administration keeps retained runtime data explicit:

  • /api/gateway/admin/users is the admin-only user list/create/read/update/delete surface.
  • /api/gateway/admin/runtime-reservations lists retained runtime reservations left by deleted or reassigned users.
  • /api/gateway/admin/runtime-reservations/{runtime_id}/transfer intentionally assigns retained runtime data to an existing same-tenant user.
  • /api/gateway/admin/runtime-reservations/{runtime_id}/purge requires exact runtime-id confirmation, deletes the retained runtime directory, then releases the runtime id for reuse.

Gateway-hosted provider endpoint profiles make reusable hosted endpoints discoverable without exposing raw keys:

  • /api/gateway/config/provider-endpoint-profiles lists and creates profiles for the current principal.
  • /api/gateway/config/provider-endpoint-profiles/discover-models previews the model list for a draft or saved profile by calling the configured provider family and base URL with the server-side or entered key. The response never echoes the raw key.
  • /api/gateway/config/provider-endpoint-profiles/{profile_id} updates or deletes an existing profile. Gateway-scoped profiles require an admin principal.
  • /api/gateway/discovery/providers includes enabled profiles as virtual providers such as endpoint:office-vllm.
  • /api/gateway/discovery/providers/{provider_name}/models resolves virtual providers through the stored profile and returns the allowed or discovered model list without returning the raw API key.