Python SDK
Typed results and errors, automatic idempotency keys, bounded retries, wait helpers for jobs and batches, and pagination.
Navigate
Kits / code and agents
Public SDKs and agent plugins for ApexAi products.
ApexSDK is the catalog of ApexAi's public developer kits: SDKs that put a product's contract into your code, and agent plugins that bring a product into Claude Code and OpenAI Codex. Each kit belongs to one product, talks only to that product, and is open source on GitHub.
The catalog
Every kit talks only to its own product, through that product's contract and policy. ApexSDK is a catalog, not a cross-product SDK: there is no shared package, base URL, or sign-on.
| Kit | Product | Kind | Runs on | Source and package | State |
|---|---|---|---|---|---|
| Scrawl SDKs and CLI | Scrawl | SDK | Python 3.10+ · Node 20+ | Open source on GitHub. Not on PyPI or npm yet. | Built |
| Scrawl agent plugin | Scrawl | Agent plugin | Claude Code · OpenAI Codex | Open source on GitHub. Not in an official plugin directory: installs from its own marketplace. | Built |
| DevOps SDK | DevOps | SDK | Python 3.11+ on Linux | Open source on GitHub. Not on PyPI yet. | In development |
| DevOps agent plugin | DevOps | Agent plugin | Claude Code | Open source on GitHub. Not in an official plugin directory: installs from its own marketplace. | In development |
SDK, MCP, or plugin?
An SDK and an agent plugin are kits around a product's own surfaces. They add no authority: every call still passes the product's identity, policy, and limits.
| Kind | What it is | Who calls it | Where it runs |
|---|---|---|---|
| ApexAPI | A product's typed HTTP contract, with scoped credentials, idempotent side effects, and stable errors. | Your software, over HTTPS | In the product |
| SDK | A library that puts one product's contract into your code: for Scrawl, clients and a command-line tool for its ApexAPI, with typed results, retries, and pagination; for DevOps, the host contract and adapters the engine uses to observe your systems. | Your code, or a terminal | In your application or integration |
| ApexMCP | A product's own MCP server: named tools and resources an AI agent discovers and calls, under the product's identity and policy. | An AI agent | Beside the product |
| Agent plugin | A package for an AI coding agent such as Claude Code or OpenAI Codex: skills that teach it the product, plus the connection to the product's MCP server or command-line tool. It holds no product logic. | An AI coding agent | In the agent's host |
| Product plugin | Operator control for one product's deployment: health, smoke tests, approvals, bounded maintenance, and evidence. | The operators of a deployment | Beside the deployment |
Scrawl SDKs and CLI · SDK
Official clients for Scrawl's ApexAPI: scrape a page to Markdown or JSON shaped by your schema, map a site, run batches and crawls into versioned datasets, query and search datasets, extract and ask with citations on your own AI provider, extract a page's files, and read your credit balance. Both SDKs share one contract exported by Scrawl, and every ApexAPI operation is mapped to its Python method, TypeScript method, and command, or to the reason it is left out.
# Not on PyPI or npm yet: install from the repository
git clone https://github.com/ApexAiOfficial/scrawl-sdk.git
python -m pip install ./scrawl-sdk/python # Python SDK and the scrawl command
npm install ./scrawl-sdk/typescript # TypeScript SDK
# Point it at the Scrawl endpoint for your account
export SCRAWL_BASE_URL=https://scrawl.example
export SCRAWL_API_KEY=... # an API key from its operator
scrawl doctor
Registry install commands in the repository work only once the packages are published; until then, install from a clone as above. The names scrawl on PyPI and on npm belong to unrelated packages: never install either in place of the SDK.
Typed results and errors, automatic idempotency keys, bounded retries, wait helpers for jobs and batches, and pagination.
The same operations, error model, and retry rules for fetch-based runtimes, with bundled type declarations.
Scrape, map, batch, crawl, extract, ask, datasets, files, and a doctor check of the URL, TLS, and key, for a terminal or a CI job.
The contract Scrawl publishes for ApexAPI, and a coverage table that maps every operation to each SDK and the command.
Scrawl agent plugin · Agent plugin
Skills that teach an AI coding agent when and how to use Scrawl, and the connection to Scrawl: its MCP endpoint, authenticated on every request with your API key, or the scrawl command. The plugin holds no scraping logic; Scrawl, operated by ApexAi, does every fetch under its own policy, permissions, and limits, and the skills treat page text as untrusted data.
# Claude Code
claude plugin marketplace add ApexAiOfficial/scrawl-plugin
claude plugin install scrawl@apexai-scrawl
# OpenAI Codex
codex plugin marketplace add ApexAiOfficial/scrawl-plugin
codex plugin add scrawl@apexai-scrawl
Then set your API key and Scrawl's MCP address in the host, as the repository's guides describe. The default address is a local one; there is no hosted Scrawl MCP endpoint yet.
Choose the operation, set up and check the connection, scrape, map, crawl, extract, ask with citations, work with datasets, and download a page's files.
The agent host connects to Scrawl's MCP endpoint, sending your API key on every request. Nothing connects until a key is set.
For downloads, the setup check, and Scrawl's HTTP API, the skills drive the scrawl command from the Scrawl SDKs.
No hooks, executables, telemetry, or network code: skills and configuration only.
DevOps SDK · SDK
The integration layer between your systems and the DevOps engine: the host contract the engine works through, adapters that observe systems, sinks that deliver attention notices, and contract checks you run in your own tests. You can build and test an adapter with the SDK alone; running it under the engine needs a DevOps engine installation, which ApexAi does not offer to customers.
# Not on PyPI: install a tagged release from the repository
pip install "apexai-devops-sdk @ git+https://github.com/ApexAiOfficial/devops-sdk@<tag>"
Pin a release tag or a commit, as the repository describes. An adapter never guesses: a system it cannot read is reported as unobservable, and the engine never acts on that.
Observations with four outcomes, the questions an adapter answers about a system, remedies, and attention notices.
Watch Docker Compose services and their health checks, read a status file another process writes, and deliver attention notices to Telegram chats.
Checks that prove your own adapter meets the contract, and offline stand-ins for the Docker daemon and the Telegram Bot API.
Wiring for running an adapter under the engine as a monitor that observes and alerts but never acts.
DevOps agent plugin · Agent plugin
Read-only inspection of a DevOps engine installation from Claude Code: its status and health, the systems it watches and who owns them, incidents, decisions, the changes it made, budgets, recovery holds, and redacted evidence, plus a triage command. Every tool it offers is a read: it never grants authority, requests a remediation, or runs a command.
# Add the repository's plugin marketplace
claude plugin marketplace add ApexAiOfficial/devops-plugin
Then install the plugin from that marketplace and point it at your engine installation, as the repository's README describes step by step, including the engine version it requires.
Status, incidents and their decisions, changes, budgets, recovery holds, control events, and redacted evidence, read from the engine's own records.
A guided look at what is unresolved, for the whole installation or one incident.
The plugin starts the engine's inspection server only after checking that the installed engine is the exact version it names and that its files match the installation's own record.
Nothing it does changes the engine or your systems: standing policy still decides every action.
Before you start
The kits are public so you can read them, build against them, and plan an integration. Using one needs a deployment of its product, which ApexAi does not offer publicly yet.
Every kit talks to one product, and ApexAi operates both: Scrawl, and the DevOps engine. The engines are proprietary and never distributed, and neither product is publicly hosted or offered for sign-up yet.
Scrawl API keys are issued for your account by ApexAi and carry named scopes. DevOps kits connect to a DevOps engine installation, which ApexAi does not offer to customers.
Scrawl's JSON extraction and cited answers run on the AI provider you bring. The kits never hold an AI key of their own.
Versions and support
Every kit is before version 1.0, so a minor version may change its interface. Pin a kit's tag where it has one. The DevOps agent plugin is a development pre-release with no tag yet: it follows its main branch and requires the exact engine version it names.
The Scrawl SDKs record the contract they were built from and check it in their own tests. The DevOps agent plugin requires the exact engine version it names.
Open an issue in the kit's repository, or write to support@apexaiofficial.com. For access to a product, write to sales@apexaiofficial.com.
Report a vulnerability privately to support@apexaiofficial.com, never in a public issue. The kits read keys from the environment, your agent host, or files only their owner can read, and never print them.
Every public ApexAi repository: ApexAi on GitHub ↗