oiyai / docs
Services

HTTP and browser access

Connect to a service without exposing an anonymous public endpoint.

Authenticated HTTP endpoints

Service details contain its endpoint URL. Use that returned URL rather than constructing one from a guessed account identifier. Requests must be authenticated for the owning account.

curl "$OIY_SERVICE_ENDPOINT" \
  -H "Authorization: Bearer $OIY_API_KEY"

Set OIY_SERVICE_ENDPOINT to the value returned in your service details. Supply the API key through your local environment; do not paste it into a public URL.

The container must listen on the configured httpPort. The proxy supports HTTP response streaming and WebSockets. Connection duration counts as activity while connected.

Wake on request

A request can wake a sleeping instance. The proxy waits up to 60 seconds. A service that is still starting returns 503 with Retry-After. Honor the retry guidance and inspect service state if startup continues to fail. Workload image size and initialization affect startup; no instant-start guarantee is made.

Browser launch

When browser access is enabled for the deployment, the console can create a short-lived browser launch session for a service. This allows browser-based applications to authenticate without placing a personal API key in the address bar.

The public catalog reports browserEnabled. Browser access requires a verified account and the appropriate service configuration. A browser launch URL is sensitive: do not share or log it.

Common connection issues

  • Service is not running or the application has not finished loading.
  • The configured port differs from the port used by your application.
  • The server listens only on a loopback interface.
  • Authentication is missing, expired, or belongs to another account.
  • The regional runtime is unavailable.

On this page