Skip to content
SupaCloud Docs
Select themeSelect language

`POST /api/commands/{word}/resolve` — step the resolver state machine for `word` with the supplied partial args. Returns `ready` (the resolved invocation), `need_param` (the next param + its options), or `invalid` (a bad value + a hint). An unknown OR role-hidden word is a 404.

POST
/api/commands/{word}/resolve
curl --request POST \
  --url https://example.com/api/commands/example/resolve \
  --header 'Content-Type: application/json' \
  --cookie supacloud_session=<supacloud_session> \
  --data '{ "args": { "additionalProperty": "example" } }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
word
required
string

Command word or alias

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

The body of POST /api/commands/{word}/resolve and .../invoke: the partial arg bindings supplied so far (param name -> value). Absent = a bare invocation; the resolver/invoker fills in / asks for the rest.

object
args

Partial argument bindings keyed by param name.

object
key
additional properties
string
Examplegenerated
{
  "args": {
    "additionalProperty": "example"
  }
}

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
One of:

Every required param is bound + valid; input is the resolved invocation.

object
input
required

A replayable command invocation (ADR §2.2): word + resolved arg bindings.

object
args
required

Resolved arg bindings (param name -> chosen value).

object
key
additional properties
string
word
required
string
status
required
string
Allowed values: ready
Example
{
  "status": "ready"
}

401

Section titled “401”

Authentication required

403

Section titled “403”

Permission denied

404

Section titled “404”

No such command

500

Section titled “500”

Structured server error