OpenCode.Generated.OpencodeHttpApi (opencode_sdk v0.1.84)

Copy Markdown View Source

Provides API endpoints related to opencode http api

Summary

Types

v2_agent_list_200_json_resp()
v2_health_get_200_json_resp()

Functions

v2_agent_list(opts \\ [])

List agents

v2_health_get(opts \\ [])

Check server health

Types

v2_agent_list_200_json_resp()

@type v2_agent_list_200_json_resp() :: %{
  data: [OpenCode.Generated.AgentV2Info.t()],
  location: OpenCode.Generated.LocationInfo.t()
}

v2_health_get_200_json_resp()

@type v2_health_get_200_json_resp() :: %{healthy: true}

Functions

v2_agent_list(opts \\ [])

@spec v2_agent_list(opts :: keyword()) ::
  {:ok, v2_agent_list_200_json_resp()}
  | {:error,
     OpenCode.Generated.InvalidRequestError.t()
     | OpenCode.Generated.UnauthorizedError.t()}

List agents

Retrieve currently registered agents.

Options

  • location

v2_health_get(opts \\ [])

@spec v2_health_get(opts :: keyword()) ::
  {:ok, v2_health_get_200_json_resp()}
  | {:error,
     OpenCode.Generated.InvalidRequestError.t()
     | OpenCode.Generated.UnauthorizedError.t()}

Check server health

Check whether the API server is ready to accept requests.