Bind an existing Session to a conversation

curl --request POST \
  --url https://api.checkfu.com/v1/conversation-bindings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'checkfu-version: <checkfu-version>' \
  --data '
{
  "external_installation_id": "<string>",
  "surface_scope_id": "<string>",
  "conversation": {
    "root_external_id": "<string>",
    "thread_external_id": null
  },
  "session_id": "<string>",
  "agent_installation_id": "<string>"
}
'

import requests

url = "https://api.checkfu.com/v1/conversation-bindings"

payload = {
    "external_installation_id": "<string>",
    "surface_scope_id": "<string>",
    "conversation": {
        "root_external_id": "<string>",
        "thread_external_id": None
    },
    "session_id": "<string>",
    "agent_installation_id": "<string>"
}
headers = {
    "checkfu-version": "<checkfu-version>",
    "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>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    external_installation_id: '<string>',
    surface_scope_id: '<string>',
    conversation: {root_external_id: '<string>', thread_external_id: null},
    session_id: '<string>',
    agent_installation_id: '<string>'
  })
};

fetch('https://api.checkfu.com/v1/conversation-bindings', 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/conversation-bindings",
  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([
    'external_installation_id' => '<string>',
    'surface_scope_id' => '<string>',
    'conversation' => [
        'root_external_id' => '<string>',
        'thread_external_id' => null
    ],
    'session_id' => '<string>',
    'agent_installation_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "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/conversation-bindings"

	payload := strings.NewReader("{\n  \"external_installation_id\": \"<string>\",\n  \"surface_scope_id\": \"<string>\",\n  \"conversation\": {\n    \"root_external_id\": \"<string>\",\n    \"thread_external_id\": null\n  },\n  \"session_id\": \"<string>\",\n  \"agent_installation_id\": \"<string>\"\n}")

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

	req.Header.Add("checkfu-version", "<checkfu-version>")
	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/conversation-bindings")
  .header("checkfu-version", "<checkfu-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"external_installation_id\": \"<string>\",\n  \"surface_scope_id\": \"<string>\",\n  \"conversation\": {\n    \"root_external_id\": \"<string>\",\n    \"thread_external_id\": null\n  },\n  \"session_id\": \"<string>\",\n  \"agent_installation_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/conversation-bindings")

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

request = Net::HTTP::Post.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"external_installation_id\": \"<string>\",\n  \"surface_scope_id\": \"<string>\",\n  \"conversation\": {\n    \"root_external_id\": \"<string>\",\n    \"thread_external_id\": null\n  },\n  \"session_id\": \"<string>\",\n  \"agent_installation_id\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "workspace_id": "<string>",
  "external_installation_id": "<string>",
  "surface_scope_id": "<string>",
  "conversation": {
    "kind": "ambient",
    "root_external_id": "<string>",
    "thread_external_id": null
  },
  "session_id": "<string>",
  "state": "active",
  "replaced_by": "<string>",
  "last_projected_message_id": "<string>",
  "reconciliation_cursor": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "agent_installation_id": "<string>",
  "projection_policy": {
    "role": "interaction",
    "classes": [
      "input"
    ],
    "delivery_grade": "provider_idempotent"
  },
  "last_projected_event_sequence": 1
}

{
  "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": "validation.conflict",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-conflict"
  }
}

{
  "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"
  }
}

Bind an existing Session to a conversation

The narrow additive create: attaches a Session you already hold the ID for to another canonical provider conversation with an explicit projection role and class policy. An installed Session must match its live AgentInstallation and SurfaceScope. A direct Session may gain only a delivery-role binding and must name the active AgentInstallation that governs the destination, so adding a projection never silently grants provider ingress. Resolve remains the live interaction path.

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

POST

conversation-bindings

curl --request POST \
  --url https://api.checkfu.com/v1/conversation-bindings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'checkfu-version: <checkfu-version>' \
  --data '
{
  "external_installation_id": "<string>",
  "surface_scope_id": "<string>",
  "conversation": {
    "root_external_id": "<string>",
    "thread_external_id": null
  },
  "session_id": "<string>",
  "agent_installation_id": "<string>"
}
'

import requests

url = "https://api.checkfu.com/v1/conversation-bindings"

payload = {
    "external_installation_id": "<string>",
    "surface_scope_id": "<string>",
    "conversation": {
        "root_external_id": "<string>",
        "thread_external_id": None
    },
    "session_id": "<string>",
    "agent_installation_id": "<string>"
}
headers = {
    "checkfu-version": "<checkfu-version>",
    "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>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    external_installation_id: '<string>',
    surface_scope_id: '<string>',
    conversation: {root_external_id: '<string>', thread_external_id: null},
    session_id: '<string>',
    agent_installation_id: '<string>'
  })
};

fetch('https://api.checkfu.com/v1/conversation-bindings', 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/conversation-bindings",
  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([
    'external_installation_id' => '<string>',
    'surface_scope_id' => '<string>',
    'conversation' => [
        'root_external_id' => '<string>',
        'thread_external_id' => null
    ],
    'session_id' => '<string>',
    'agent_installation_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "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/conversation-bindings"

	payload := strings.NewReader("{\n  \"external_installation_id\": \"<string>\",\n  \"surface_scope_id\": \"<string>\",\n  \"conversation\": {\n    \"root_external_id\": \"<string>\",\n    \"thread_external_id\": null\n  },\n  \"session_id\": \"<string>\",\n  \"agent_installation_id\": \"<string>\"\n}")

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

	req.Header.Add("checkfu-version", "<checkfu-version>")
	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/conversation-bindings")
  .header("checkfu-version", "<checkfu-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"external_installation_id\": \"<string>\",\n  \"surface_scope_id\": \"<string>\",\n  \"conversation\": {\n    \"root_external_id\": \"<string>\",\n    \"thread_external_id\": null\n  },\n  \"session_id\": \"<string>\",\n  \"agent_installation_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/conversation-bindings")

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

request = Net::HTTP::Post.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"external_installation_id\": \"<string>\",\n  \"surface_scope_id\": \"<string>\",\n  \"conversation\": {\n    \"root_external_id\": \"<string>\",\n    \"thread_external_id\": null\n  },\n  \"session_id\": \"<string>\",\n  \"agent_installation_id\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "workspace_id": "<string>",
  "external_installation_id": "<string>",
  "surface_scope_id": "<string>",
  "conversation": {
    "kind": "ambient",
    "root_external_id": "<string>",
    "thread_external_id": null
  },
  "session_id": "<string>",
  "state": "active",
  "replaced_by": "<string>",
  "last_projected_message_id": "<string>",
  "reconciliation_cursor": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "agent_installation_id": "<string>",
  "projection_policy": {
    "role": "interaction",
    "classes": [
      "input"
    ],
    "delivery_grade": "provider_idempotent"
  },
  "last_projected_event_sequence": 1
}

{
  "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": "validation.conflict",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-conflict"
  }
}

{
  "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

idempotency-key

string

Maximum string length: 255

Body

application/json

external_installation_id

string

required

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

surface_scope_id

string

required

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

conversation

object

required

Option 1
Option 2

Show child attributes

session_id

string

required

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

agent_installation_id

string

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

projection_policy

object

Show child attributes

Response

Success

string

required

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

workspace_id

string

required

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

external_installation_id

string

required

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

surface_scope_id

string

required

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

conversation

object

required

Option 1
Option 2

Show child attributes

session_id

string

required

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

state

enum<string>

required

Available options:

active,

replaced,

archived

replaced_by

string | null

required

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

last_projected_message_id

string | null

required

Required string length: 1 - 512

reconciliation_cursor

string | null

required

Required string length: 1 - 512

created_at

string

required

updated_at

string

required

agent_installation_id

string

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

projection_policy

object

Show child attributes

last_projected_event_sequence

integer

Required range: x > 0

Developer tools

Canonical tables

Author protocols

Generated HTTP API

Bind an existing Session to a conversation

Authorizations

Headers

Body

Response