Prepare workspace pull session
POST
/v1/workspace-bindings/{bindingId}/pull-sessionsPersist a prepared remote-to-local pull preview for a binding without changing local files yet.
How to call this endpoint
Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.
Path, query, and header parameters
These parameters control which ACP object the endpoint acts on and how the request is processed.
Path parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| bindingId | path | string | Yes | Workspace binding ID |
Query parameters
None.
Body schema
Content type: application/json · Required
| Field | Type | Required | Description |
|---|---|---|---|
| planSignature | string | Yes | — |
| plan | object | Yes | — |
| metadata | object | No | Free-form metadata object. |
What the API returns
Each response code below includes the documented payload shape for the ACP API.
200Existing prepared workspace pull session reusedapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| pullSession | object | No | — |
| pullSession.id | string | No | Unique identifier. |
| pullSession.workspaceBindingId | string | No | — |
| pullSession.userId | string | No | User ID. |
| pullSession.deviceId | string | No | — |
| pullSession.environmentId | string | No | Computer ID. |
| pullSession.projectId | string | No | Project ID. |
| pullSession.status | prepared | superseded | cancelled | No | Current lifecycle status. |
| pullSession.planSignature | string | No | — |
| pullSession.plan | object | No | — |
| pullSession.metadata | object | No | Free-form metadata object. |
| pullSession.createdAt | string | No | ISO 8601 timestamp. |
| pullSession.updatedAt | string | No | ISO 8601 timestamp. |
| created | boolean | No | — |
201Workspace pull session preparedapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| pullSession | object | No | — |
| pullSession.id | string | No | Unique identifier. |
| pullSession.workspaceBindingId | string | No | — |
| pullSession.userId | string | No | User ID. |
| pullSession.deviceId | string | No | — |
| pullSession.environmentId | string | No | Computer ID. |
| pullSession.projectId | string | No | Project ID. |
| pullSession.status | prepared | superseded | cancelled | No | Current lifecycle status. |
| pullSession.planSignature | string | No | — |
| pullSession.plan | object | No | — |
| pullSession.metadata | object | No | Free-form metadata object. |
| pullSession.createdAt | string | No | ISO 8601 timestamp. |
| pullSession.updatedAt | string | No | ISO 8601 timestamp. |
| created | boolean | No | — |