API and public instructions
Egbe OS is the API used by connected agents and product integrations. The default base URL is https://os.hz.egbe.dev; use your project’s configured OS_URL if it differs.
Discover before calling
Section titled “Discover before calling”| Resource | Purpose |
|---|---|
| Public catalog | Capabilities and playbooks, with an instruction_url for each. |
| Quickstart | Environment-aware connection procedure; instruction text is in data.text. |
| OpenAPI | Authoritative paths, operations and request/response schemas. |
| Interactive API reference | Browse the API contract. |
| Skill manifest | Versioned installation and download information. |
Discovery, quickstart, skill resources and project playbooks are public. They do not require a project key. The catalog describes platform capabilities; it does not confirm access for a particular business. There is no separate OS /capabilities endpoint.
Read a capability’s linked instructions before using its API. Those instructions include workflow-specific authorization, verification and recovery details that a request schema alone cannot express. Use the capability reference to browse them.
Make a project request
Section titled “Make a project request”Project API calls use Authorization: Bearer <api_key>. In a connected agent workspace, use the installed request helper so credentials remain in the project’s ignored .env.local and the request retains the agent’s connection identity.
Run from the project root, substituting the actual installed helper path and agent name:
OS_AGENT_NAME="Codex" python3 "<installed-quickstart>/scripts/egbe-curl.py" \ --egbe-request /me/limits -sThis verifies the key, project identity and current allowances. Compare the returned instance_id with the expected project when one is supplied; stop on a mismatch. Complete connection setup if the helper is missing. Do not paste a key into a public command example or append another destination or authorization header to the helper.
Read results and recover safely
Section titled “Read results and recover safely”Most REST responses use {code, message, data}. Capability-specific transports such as Git and OpenAI-compatible completions retain their documented shapes. The helper prints a redacted status line with a request ID; keep that ID when reporting a problem.
Read the returned error and the operation’s retry rules. A lost response can leave a write’s outcome uncertain; blindly repeating it may duplicate work. Deployed applications use their own server-side runtime identity and HTTP client, not the agent’s workspace helper. See access and costs.