Skip to main content

Weave API Reference

caution

The Weave API is available to customers on the Weave Enterprise plan only

info

Note: The Weave API is distinct from the Figma REST API. The Weave API uses a different base URL and provides a separate set of endpoints.

The Weave API lets you run Weave tools programmatically. A tool is built as a workflow in Weave and published for execution. Use the API to list the tools in your workspace, discover a tool's inputs and outputs, start runs, track their status by polling or webhook, and retrieve the generated results from your own tools and services.

Because rendering assets takes a variable amount of time, the API is asynchronous. Starting a run returns immediately with a run ID. Poll the run status endpoint to track progress and retrieve outputs when the run completes, or register a webhook when starting a run to be notified the moment it finishes.

Weave API Prerequisites​

To interact with the Weave API, you need an API token.

Generate an API token​

Before you start making requests, you'll need to generate an API token to use with the Weave API. You must be a workspace admin to generate a token.

  1. Sign in to your Weave workspace.
  2. Open Settings > API Tokens.
  3. Click Generate API Token, give it a name, choose expiration, and copy the secret immediately. It is shown only once.
note

Note: To generate API tokens, you must be a workspace admin. Your workspace can have up to 10 active tokens at a time. To rotate, revoke the old token first.

Weave API Base URL​

The base URL for the Weave API: https://developer.api.weavy.ai

All endpoints are versioned under /v1.

The API token must be included in an X-Figma-Token header when calling any of the Weave API methods.

For POST write operations, provide a JSON request body and set the HTTP Content-type header to application/json.

Example

GET https://developer.api.weavy.ai/v1/tools/:tool_id/inspect
X-Figma-Token: [WEAVE API TOKEN]

OpenAPI spec​

The Weave API has an OpenAPI spec you can download as JSON or YAML.