Framer Server API

https://www.framer.com/developers/server-api-reference
Admin
Framer Server API is a backend API for programmatically managing Framer projects, including creating...
Tokens:1,581
Snippets:12
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### Get Changed Paths Between Versions

Source: https://www.framer.com/developers/server-api-reference

Retrieves the paths of pages that have been added, removed, or modified between two versions.

```APIDOC
## Get Changed Paths Between Versions

### Description
Retrieves the paths of pages that have changed between specified versions. It returns lists of added, removed, and modified paths.

### Method
GET (implied by `getChangedPaths` method usage)

### Endpoint
Not explicitly defined, but the `getChangedPaths` method is called on the framer object.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```javascript
const changes = await framer.getChangedPaths()
// changes will be { added: string[], removed: string[], modified: string[] }
```

### Response
#### Success Response (200)
- **added** (string[]) - An array of page paths that were added.
- **removed** (string[]) - An array of page paths that were removed.
- **modified** (string[]) - An array of page paths that were modified.

#### Response Example
```json
{
  "added": ["/new-page"],
  "removed": ["/old-page"],
  "modified": ["/index"]
}
```
```

--------------------------------

### Get Contributors of Changes Between Versions

Source: https://www.framer.com/developers/server-api-reference

Fetches a list of authors who made changes to the project between specified versions. Defaults to the latest two versions if not provided.

```javascript
framer.getChangeContributors(fromVersion?: number, toVersion?: number): Promise<string[]>
```

--------------------------------

### Get Change Contributors Between Versions

Source: https://www.framer.com/developers/server-api-reference

Fetches the list of authors who made changes between two specified versions.

```APIDOC
## Get Change Contributors Between Versions

### Description
Retrieves a list of authors who contributed changes between two optional version numbers.

### Method
GET (implied by `getChangeContributors` method usage)

### Endpoint
Not explicitly defined, but the `getChangeContributors` method is called on the framer object.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```javascript
// Get contributors for all changes
const contributorsAll = await framer.getChangeContributors()

// Get contributors between specific versions
const contributorsSpecific = await framer.getChangeContributors(1, 5)
```

### Response
#### Success Response (200)
- **contributors** (string[]) - An array of author names or identifiers.

#### Response Example
```json
[
  "Alice",
  "Bob"
]
```
```

--------------------------------

### Get Changed Page Paths Between Versions

Source: https://www.framer.com/developers/server-api-reference

Retrieves the paths of pages that have been added, removed, or modified between two versions of a Framer project.

```javascript
framer.getChangedPaths(): Promise<{ added: string[], removed: string[], modified: string[] }>
```

--------------------------------

### Publish New Preview Link

Source: https://www.framer.com/developers/server-api-reference

Publishes a new preview link for the current project state. Returns the deployment ID upon successful publication.

```javascript
framer.publish(): Promise<{deployment: { id: string }}>
```

--------------------------------

### Promote a Published Link to Production

Source: https://www.framer.com/developers/server-api-reference

Promotes a previously published preview link to the production environment.

```APIDOC
## Promote a Published Link to Production

### Description
Promotes a specific published deployment link to become the production version.

### Method
POST (implied by `deploy` method usage)

### Endpoint
Not explicitly defined, but the `deploy` method is called on the framer object.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```javascript
// Assuming 'deployment.id' was obtained from framer.publish()
const deploymentId = "deployment_123abc"
framer.deploy(deploymentId)
```

### Response
#### Success Response (200)
No specific return value mentioned, implies success upon execution.

#### Response Example
```javascript
// No response body is typically returned for a deploy operation.
```
```

--------------------------------

### Connect to a Framer Project

Source: https://www.framer.com/developers/server-api-reference

Establishes a persistent connection to a Framer project using project URL and an API key. This connection requires manual disconnection.

```APIDOC
## Connect to a Framer Project

### Description
Creates a long-lived connection to a Framer project. This connection requires explicit manual disconnection.

### Method
POST (implied by `connect` function usage)

### Endpoint
Not explicitly defined, but the `connect` function is used.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```javascript
import { connect } from "framer-api"

const framer = await connect(projectUrl, process.env.FRAMER_API_KEY)
```

### Response
#### Success Response (200)
- **framer** (object) - An object representing the connection to Framer, with methods like `disconnect`, `getChangedPaths`, etc.

#### Response Example
```javascript
// The 'framer' object returned by connect()
const framer = {
  disconnect: () => { /* ... */ },
  getChangedPaths: () => { /* ... */ },
  getChangeContributors: () => { /* ... */ },
  publish: () => { /* ... */ },
  deploy: () => { /* ... */ }
}
```
```

--------------------------------

### Promote Published Link to Production

Source: https://www.framer.com/developers/server-api-reference

Promotes a previously published deployment to the production environment using its deployment ID.

```javascript
framer.deploy(deployment.id)
```

--------------------------------

### Connect to Framer Project

Source: https://www.framer.com/developers/server-api-reference

Establishes a long-lived connection to a Framer project using a project URL and API key. Manual disconnection is required.

```javascript
import { connect } from "framer-api"

const framer = await connect(projectUrl, process.env.FRAMER_API_KEY)
```

--------------------------------

### Publish a New Preview Link

Source: https://www.framer.com/developers/server-api-reference

Publishes a new preview link for the project.

```APIDOC
## Publish a New Preview Link

### Description
Publishes a new preview link for the current project.

### Method
POST (implied by `publish` method usage)

### Endpoint
Not explicitly defined, but the `publish` method is called on the framer object.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```javascript
const result = await framer.publish()
// result will be { deployment: { id: string } }
```

### Response
#### Success Response (200)
- **deployment** (object) - An object containing deployment information.
  - **id** (string) - The unique identifier for the deployment.

#### Response Example
```json
{
  "deployment": {
    "id": "deployment_123abc"
  }
}
```
```

--------------------------------

### Disconnect from Framer

Source: https://www.framer.com/developers/server-api-reference

Manually closes the established connection to Framer.

```APIDOC
## Disconnect from Framer

### Description
Manually closes the established connection to Framer.

### Method
POST (implied by `disconnect` method usage)

### Endpoint
Not explicitly defined, but the `disconnect` method is called on the framer object.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```javascript
framer.disconnect()
```

### Response
#### Success Response (200)
No specific return value mentioned, implies success upon execution.

#### Response Example
```javascript
// No response body is typically returned for a disconnect operation.
```
```

--------------------------------

### Disconnect from Framer Project

Source: https://www.framer.com/developers/server-api-reference

Closes the established connection to the Framer project. This should be called explicitly when the connection is no longer needed.

```javascript
framer.disconnect()
```
Tokens:
Raw