Add a Session Resource

curl --request POST \
  --url https://api.checkfu.com/v1/sessions/{session_id}/resources \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'checkfu-beta: <checkfu-beta>' \
  --header 'checkfu-version: <checkfu-version>' \
  --data '
{
  "file_id": "<string>",
  "type": "file",
  "mount_path": "<string>"
}
'

import requests

url = "https://api.checkfu.com/v1/sessions/{session_id}/resources"

payload = {
    "file_id": "<string>",
    "type": "file",
    "mount_path": "<string>"
}
headers = {
    "checkfu-version": "<checkfu-version>",
    "checkfu-beta": "<checkfu-beta>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'checkfu-version': '<checkfu-version>',
    'checkfu-beta': '<checkfu-beta>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({file_id: '<string>', type: 'file', mount_path: '<string>'})
};

fetch('https://api.checkfu.com/v1/sessions/{session_id}/resources', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.checkfu.com/v1/sessions/{session_id}/resources",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'file_id' => '<string>',
    'type' => 'file',
    'mount_path' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "checkfu-beta: <checkfu-beta>",
    "checkfu-version: <checkfu-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.checkfu.com/v1/sessions/{session_id}/resources"

	payload := strings.NewReader("{\n  \"file_id\": \"<string>\",\n  \"type\": \"file\",\n  \"mount_path\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("checkfu-version", "<checkfu-version>")
	req.Header.Add("checkfu-beta", "<checkfu-beta>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.checkfu.com/v1/sessions/{session_id}/resources")
  .header("checkfu-version", "<checkfu-version>")
  .header("checkfu-beta", "<checkfu-beta>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"file_id\": \"<string>\",\n  \"type\": \"file\",\n  \"mount_path\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/sessions/{session_id}/resources")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["checkfu-beta"] = '<checkfu-beta>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"file_id\": \"<string>\",\n  \"type\": \"file\",\n  \"mount_path\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "file_id": "<string>",
  "mount_path": "<string>",
  "type": "file"
}

{
  "error": {
    "type": "validation.malformed",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-malformed"
  }
}

{
  "error": {
    "type": "auth.invalid_key",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-invalid-key"
  }
}

{
  "error": {
    "type": "auth.disabled_tenancy",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
  }
}

{
  "error": {
    "type": "validation.not_found",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-not-found"
  }
}

{
  "error": {
    "type": "runtime.invalid_transition",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#runtime-invalid-transition"
  }
}

{
  "error": {
    "type": "budget.exceeded",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#budget-exceeded"
  }
}

{
  "error": {
    "type": "runtime.internal",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#runtime-internal"
  }
}

Add a Session Resource

Attaches one uploaded File to a live Session and returns its immutable File Resource snapshot. The File must belong to the selected Workspace, mount paths cannot overlap, and a Session accepts at most 500 File Resources. The Resource and its read-only runtime mount are committed atomically.

Checkfu support posture: alpha; hosted. Required evidence journey: session-turn. Deployment-specific readiness and the latest proven release are available from GET /v1/support/capabilities.

POST

sessions

{session_id}

resources

Add a Session Resource

curl --request POST \
  --url https://api.checkfu.com/v1/sessions/{session_id}/resources \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'checkfu-beta: <checkfu-beta>' \
  --header 'checkfu-version: <checkfu-version>' \
  --data '
{
  "file_id": "<string>",
  "type": "file",
  "mount_path": "<string>"
}
'

import requests

url = "https://api.checkfu.com/v1/sessions/{session_id}/resources"

payload = {
    "file_id": "<string>",
    "type": "file",
    "mount_path": "<string>"
}
headers = {
    "checkfu-version": "<checkfu-version>",
    "checkfu-beta": "<checkfu-beta>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'checkfu-version': '<checkfu-version>',
    'checkfu-beta': '<checkfu-beta>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({file_id: '<string>', type: 'file', mount_path: '<string>'})
};

fetch('https://api.checkfu.com/v1/sessions/{session_id}/resources', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.checkfu.com/v1/sessions/{session_id}/resources",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'file_id' => '<string>',
    'type' => 'file',
    'mount_path' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "checkfu-beta: <checkfu-beta>",
    "checkfu-version: <checkfu-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.checkfu.com/v1/sessions/{session_id}/resources"

	payload := strings.NewReader("{\n  \"file_id\": \"<string>\",\n  \"type\": \"file\",\n  \"mount_path\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("checkfu-version", "<checkfu-version>")
	req.Header.Add("checkfu-beta", "<checkfu-beta>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.checkfu.com/v1/sessions/{session_id}/resources")
  .header("checkfu-version", "<checkfu-version>")
  .header("checkfu-beta", "<checkfu-beta>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"file_id\": \"<string>\",\n  \"type\": \"file\",\n  \"mount_path\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/sessions/{session_id}/resources")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["checkfu-beta"] = '<checkfu-beta>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"file_id\": \"<string>\",\n  \"type\": \"file\",\n  \"mount_path\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "file_id": "<string>",
  "mount_path": "<string>",
  "type": "file"
}

{
  "error": {
    "type": "validation.malformed",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-malformed"
  }
}

{
  "error": {
    "type": "auth.invalid_key",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-invalid-key"
  }
}

{
  "error": {
    "type": "auth.disabled_tenancy",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
  }
}

{
  "error": {
    "type": "validation.not_found",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-not-found"
  }
}

{
  "error": {
    "type": "runtime.invalid_transition",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#runtime-invalid-transition"
  }
}

{
  "error": {
    "type": "budget.exceeded",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#budget-exceeded"
  }
}

{
  "error": {
    "type": "runtime.internal",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#runtime-internal"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

checkfu-version

enum<string>

required

Available options:

2026-08-24

checkfu-beta

string

required

Path Parameters

session_id

string

required

Pattern: ^sess_[0-9a-f]{32}$

Body

application/json

file_id

string

required

Pattern: ^file_[0-9a-f]{32}$

type

enum<string>

required

Available options:

file

mount_path

string | null

Required string length: 2 - 1024

Response

BetaManagedAgentsFileResource

string

required

Pattern: ^sesrsc_[0-9a-f]{32}$

created_at

string

required

A canonical UTC ISO-8601 timestamp with millisecond precision.

Maximum string length: 24

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$

updated_at

string

required

A canonical UTC ISO-8601 timestamp with millisecond precision.

Maximum string length: 24

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$

file_id

string

required

Pattern: ^file_[0-9a-f]{32}$

mount_path

string

required

Required string length: 2 - 1024

type

enum<string>

required

Available options:

file

Developer tools

Canonical tables

Author protocols

Generated HTTP API

Add a Session Resource

Authorizations

Headers

Path Parameters

Body

Response