Skip to navigation

compute_channel

View as Markdown

Upgrade with the restricted executor credential in the Authorization header only; the route accepts no query parameters. The upgrade is refused with the HTTP route status (401, 403, 409) when the credential, its owner epoch or the environment is not current. Use the channel only while the handshake and work page advertise transport ‘channel’.

Handshake

WSS
wss://api.sikaru.ai/v1/projects/:project_id/compute-attachments/:attachment_id/channel

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

OR
AuthorizationBearer

Header authentication of the form Bearer <token>

Path parameters

attachment_idstringRequired
project_idstringRequired

Send

publishobjectRequired

Receive

subscribeobjectRequired