Skip to main content
POST
/
projects
/
{projectId}
/
analysis
Generate specifications for the Project
curl --request POST \
  --url https://local.withsutro.com/projects/{projectId}/analysis \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-sutro-api-client: <api-key>' \
  --data '
{
  "modes": [
    "design_system"
  ]
}
'

Authorizations

​
Authorization
string
header
required

Builder authentication and authorization

​
x-sutro-api-client
string
header
required

A unique identifier for the API Client making a request

Path Parameters

​
projectId
string
required

Body

application/json

The set of analysis modes to run

​
modes
enum<string>[]
required

The analysis modes to run when generating specifications.

One or more of the following can be selected:

  • design_system: extract design tokens, components, spacing, typography
  • information_architecture: extract pages, screens, structure
  • user_flows: extract user flows and journeys
Available options:
design_system,
information_architecture,
user_flows

Response

Specification generation started