Skip to main content
POST
Test a procedure lookup

Authorizations

Authorization
string
header
required

An org API key (gh_live_…) from Settings → API keys in the console.

Path Parameters

agent_id
string
required

Body

application/json
need
string
required

What the agent needs to do, in a sentence.

Maximum string length: 500
prompt
string

The request it came from (defaults to need).

kinds
enum<string>[]

Only procedures of these kinds (all without).

Available options:
browser,
desktop,
chat

Response

The match.

object
enum<string>
Available options:
procedure_match
procedure
object | null
confidence
number | null
reason
enum<string> | null

Why none was picked (null when one was).

Available options:
no_procedures,
none_fit,
low_confidence,
timeout,
error,
null
candidates
object[]
ms
integer