Skip to main content
GET
/
projects
/
{projectId}
/
analysis
Get the generated specifications for the Project
curl --request GET \
  --url https://local.withsutro.com/projects/{projectId}/analysis \
  --header 'Authorization: Bearer <token>' \
  --header 'x-sutro-api-client: <api-key>'
{
  "metadata": {
    "figmaFileKey": "<string>",
    "figmaFileName": "<string>",
    "analyzedAt": "2023-11-07T05:31:56Z",
    "accessLevel": "enterprise",
    "analysisModes": [
      "<string>"
    ]
  },
  "summary": "<string>",
  "designSystem": {
    "overview": "<string>",
    "colors": {
      "description": "<string>",
      "context": {}
    },
    "typography": {
      "description": "<string>",
      "context": {}
    },
    "spacing": {
      "description": "<string>",
      "context": {}
    },
    "components": {
      "description": "<string>",
      "context": {}
    },
    "effects": {
      "description": "<string>",
      "context": {}
    },
    "layout": {
      "description": "<string>",
      "context": {}
    }
  },
  "informationArchitecture": {
    "description": "<string>",
    "pages": [
      {
        "name": "<string>",
        "description": "<string>",
        "screens": [
          {
            "description": "<string>",
            "context": {}
          }
        ]
      }
    ],
    "navigation": "<string>"
  },
  "userFlows": [
    {
      "name": "<string>",
      "description": "<string>",
      "context": {}
    }
  ],
  "notes": [
    "<string>"
  ]
}

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

Response

The generated specifications

metadata
object
required
summary
string
required
designSystem
object
informationArchitecture
object
userFlows
object[]
notes
string[]