Skip to main content
GET
Get Use Case

Authorizations

Authorization
string
header
required

The access_token returned by POST /apikeys/token for an API key's secret.

Path Parameters

use_case_id
string
required

Query Parameters

Response

Successful Response

id
string
required
name
string
required
vertical
VerticalRef · object
required
shape
enum<string>
required
Available options:
workflow,
agent,
agent+workflow,
scheduled-workflow
outcome
string
required
problem
string
required
priority
enum<string>
required
Available options:
core,
standard,
niche
time_to_value_days
integer
required
readiness
Readiness · object
required

How close the caller's organisation is to running a use case.

activations
Activation · object[]
required
who
string
required
what_it_does
string
required
trigger
enum<string>
required
Available options:
manual,
manual/api,
api,
chat,
schedule,
schedule/api
how_it_works
string[]
required
approvals
string[]
required
kpis
string[]
required
complexity
enum<string>
required
Available options:
S,
M,
L
time_to_value
string
required
prerequisites
string[]
required
limits
string[]
required
better_with
SystemNeed · object[]
required
we_arrange
string[]
required
activation
ActivationForm · object
required

What activating the use case creates and what it will ask.