Skip to main content
GET
Get an OpenCode Server

Authorizations

Authorization
string
header
required

workspace API token (sk_akua_...) or OAuth2 JWT. Create tokens at https://akua.dev/developers/api-tokens

Headers

akua-context
string

Optional workspace/scope context for the request. Carries a single workspace wire id (ws_…) today. Only needed for broad tokens - a workspace-owned token implies its workspace.

Required string length: 1 - 53
Example:

"ws_j572abc123def456"

Path Parameters

id
string
required

OpenCode Server id (oc_...).

Pattern: ^oc_[a-z0-9]{1,64}$
Example:

"oc_j572abc123def456"

Response

OpenCode Server

id
string
required

OpenCode Server id (oc_...).

Pattern: ^oc_[a-z0-9]{1,64}$
Example:

"oc_j572abc123def456"

workspace_id
string
required
Required string length: 1 - 53
name
string
required

Display name.

Required string length: 1 - 100
hostname
string
required

DNS label chosen for the server's browser UI; unique across the platform. Created from the name plus a short random suffix when not given. The UI is served at web_url until chosen hostnames are routed.

Pattern: ^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$
Example:

"acme-agents"

labels
object
required

Free-form string labels: up to 32 keys of up to 63 characters.

state
enum<string>
required

ACTIVE: serves OpenCode protocol traffic. SUSPENDED: the gateway refuses protocol traffic until it is resumed. DELETED: terminal; the id stays reserved. SUSPENDING, RESUMING and DELETING: a requested change is in progress; its Operation finishes when the server reached the new state. A deletion always finishes.

Available options:
ACTIVE,
SUSPENDING,
SUSPENDED,
RESUMING,
DELETING,
DELETED
default
boolean
required

True for the Workspace's default server, which exists as soon as the Workspace uses OpenCode and cannot be deleted.

budget
object
required
model_credential_source
object
required

Whose provider access pays for the models this server uses. Always explicit; there is no default.

features
object
required

Web UI feature toggles. Everything else in OpenCode's UI stays on.

usage
object
required

Raw usage counters for later pricing. They carry no prices.

web_url
string | null
required

Where people open the server's web UI: https://oc-<key>.akua.run/, a browser origin of its own, derived from the server id. null when this deployment hosts no OpenCode Servers.

server_url
string | null
required

The long form of the server's address, https://<api host>/v1/opencodes/{id}/: OpenCode's protocol under api/, its web UI at the base. null when this deployment hosts no OpenCode Servers.

short_url
string | null
required

The short form, https://<site host>/{id}/: protocol requests only, always with an explicit token. null when this deployment has none.

created_at
integer
required

Unix timestamp (seconds)

Required range: x >= 0
updated_at
integer
required

Unix timestamp (seconds)

Required range: x >= 0
etag
string
required

Send as If-Match on PATCH.