Figma REST API Specification

The TypeScript types are generated from the OpenAPI specification using a custom generator optimized for the Figma REST API. They follow specific naming patterns:

• Named Types: All OpenAPI schemas, responses, and request parameters are exported as named types (e.g., Paint, VariableAlias).
• Endpoint-Associated Types: Types related to specific API endpoints are prefixed with the OpenAPI operation ID. For example, the getFile operation generates:
  • GetFilePathParams
  • GetFileQueryParams
  • GetFileResponse
• Request Bodies: For endpoints that expect a request body, the types are suffixed with RequestBody (e.g., postComments -> PostCommentsRequestBody).

To use the Figma REST API TypeScript types in your project, install the @figma/rest-api-spec package as a development dependency using npm.

npm install --save-dev @figma/rest-api-spec

Import the generated types from @figma/rest-api-spec to annotate your API responses or request bodies. This provides type safety when using HTTP clients like axios.

import { type GetFileResponse } from '@figma/rest-api-spec'

// Many popular HTTP clients let you annotate response types
const result = await axios.get<GetFileResponse>(url);
result.data // This has type GetFileResponse