SDKs and API Clients

AuthProxy is HTTP-first. Any application that can make an HTTP request can manage resources and send requests through a connection. The repository also includes a JavaScript/TypeScript client and an ap command-line client.

Choose an interface

Need	Use
Manage AuthProxy resources from JavaScript or TypeScript	@authproxy/api
Send a normal JSON or other buffered request through a connection	The wrapped proxy endpoint from any HTTP client, or the shared client exported by @authproxy/api
Stream uploads, downloads, or server-sent events	The raw proxy endpoint, normally through ap proxy
Explore or script an environment from a terminal	The ap CLI

The JavaScript SDK currently provides the broadest typed client surface in this repository. Other languages can call the same HTTP APIs directly.

Authentication

Calls to AuthProxy require an AuthProxy session or JWT. This authenticates the caller to AuthProxy; it is not the credential for the third-party API.

When an application proxies through a connection, it sends the connection ID and the upstream request. AuthProxy authorizes the caller, loads the connection’s encrypted credentials, applies them to the upstream request, and manages refresh or rotation behavior for the connector’s authentication method.

For proxy requests, the caller needs the connections:proxy permission for the target connection. Scope application tokens to only the namespaces, resources, verbs, and resource IDs they require.

Proxying model

sequenceDiagram
    participant App as Host application
    participant AP as AuthProxy
    participant Provider as Third-party API

    App->>AP: Request + connection ID
    AP->>AP: Authorize caller and load credentials
    AP->>Provider: Request with connection authentication
    Provider-->>AP: Upstream response
    AP-->>App: Wrapped or streamed response

The host application never needs the third-party OAuth token or API key. See Proxying requests for both request formats and runnable examples.