Skip to main content
POST
Recommend a site or an app for a new project

Authorizations

Authorization
string
header
required

A company admin credential for your company, or a droplet installation token with the website scope for reads, except on the share routes, which refuse a droplet token.

Body

application/json

What is being built, and the needs the caller already knows. Every field is optional. A need left out is read from the description; a need set to false is not.

description
string | null

What the user is building, in their words.

Maximum string length: 10000
needs
object

The needs the caller knows, each a Boolean.

Response

The recommendation.

Whether to launch the project as a site or an app, and why.

kind
enum<string>
required

site (static files on the sites gateway, with light functions and a database) unless the project needs a custom domain, server rendering or heavy server code, which make it an app (Mist).

Available options:
site,
app
reasons
object[]
required

Why, one entry for each need found, or why a site fits.

status
integer
required

The HTTP status.

meta
object
required

Response metadata included on every response body.