Reference
The interfaces Orca Agent Engine exposes - the CLI, TypeScript, Python, and Go SDKs, and their API specifications.
Use the ork command-line interface, the TypeScript, Python, or Go SDK, or the registry HTTP API to work with Agent Engine. The CLI also manages StreamNative Cloud streaming resources such as connections, functions, and connectors; the SDKs provide typed clients for application code.
Credential names are not interchangeable across clients. The CLI reads ORCA_REGISTRY_URL and either ORCA_API_KEY for x-api-key or ORCA_ACCESS_TOKEN for Bearer authentication. All three SDKs use ORCA_BASE_URL; TypeScript and Python send their ORCA_API_KEY setting as Bearer, while Go sends it as x-api-key. Go also accepts ORCA_ACCESS_TOKEN for Bearer authentication.
CLI
Install and configure ork, then browse every command group.
TypeScript SDK
Install, authenticate, paginate, and stream with @runorca/orca-sdk.
Python SDK
Install runorca and use its synchronous or asynchronous client.
Go SDK
Install the public Go module and use its typed registry client.
Registry API
Every registry operation, generated from the OpenAPI specification.
WorkspaceSpec
Field reference for the Workspace custom resource that hosts Agent Engine.
Glossary
The terms this documentation uses, and how each one is capitalized.