Add a file resource to an existing Forward session.
POST /api/v1/forward/sessions/{session_id}/resources
Mounts an additional file resource in the sandbox runtime of an existing session. Use this endpoint when you need to upload a file while a session is in progress. The file must first be uploaded through the Files API. This endpoint accepts only type: "file".
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer <PAT or SAT> |
| Content-Type | Yes | application/json |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| session_id | string | Yes | Session ID. |
Request body
| Parameter | Type | Required | Description |
|---|---|---|---|
| type | string | Yes | Resource type. Must be file. |
| file_id | string | Yes | File ID returned by the Files API. The file must have finished uploading. |
| mount_path | string | No | Mount path in the Agent container. If omitted, Forward generates a path from the file name. The default is /data/workspace/<file-name>. |
Example request
Example response
HTTP 200 OK
Response fields
| Field | Type | Description |
|---|---|---|
| id | string | Session resource ID, prefixed with sesr_. |
| type | string | Resource type. Always file. |
| file_id | string | Mounted File ID. |
| mount_path | string | Actual mount path in the Agent container. |
| created_at | string | Resource creation time in RFC 3339 format. |
| updated_at | string | Resource update time in RFC 3339 format. |
Errors
| HTTP | Type | Code | Trigger |
|---|---|---|---|
| 400 | invalid_request_error | invalid_request_body | The request body is not valid JSON. |
| 400 | invalid_request_error | invalid_resource | type is not file, file_id is missing, or a field contains control characters. |
| 404 | not_found_error | session_not_found | The session does not exist. |
| 404 | not_found_error | file_not_found | The file does not exist or has been deleted. |
| 409 | conflict_error | session_archived | The session is archived. |
| 409 | conflict_error | resource_conflict | The mount path conflicts with an existing session resource, or the file is already mounted in the session. |
| 401 | authentication_error | authentication_required | The PAT or SAT is invalid or expired. |
Notes
- The file must first be uploaded successfully through the Files API. After it is mounted, the Agent can read it from the container.
- If
mount_pathis omitted, Forward generates/data/workspace/<file-name>. Explicitly specifymount_pathwhen mounting files with the same name to avoid overwriting. - This endpoint supports only adding file resources. Other resource types are rejected.
- You cannot add resources to an archived session. Create a new session to continue.