Resolve a ConversationBinding for a conversation
curl --request POST \
--url https://api.checkfu.com/v1/conversation-bindings/resolve \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'checkfu-version: <checkfu-version>' \
--data '
{
"external_installation_id": "<string>",
"agent_installation_id": "<string>",
"surface_scope_id": "<string>",
"conversation": {
"root_external_id": "<string>",
"thread_external_id": null
},
"principal": "<string>",
"session_id": "<unknown>",
"agent": "<unknown>",
"agent_deployment_revision_selection": "<unknown>",
"mounts": "<unknown>",
"acted_as": "<unknown>",
"caused_by": "<unknown>",
"harness": "<unknown>",
"model_routing_profile_key": "<unknown>",
"sandbox_profile_key": "<unknown>"
}
'import requests
url = "https://api.checkfu.com/v1/conversation-bindings/resolve"
payload = {
"external_installation_id": "<string>",
"agent_installation_id": "<string>",
"surface_scope_id": "<string>",
"conversation": {
"root_external_id": "<string>",
"thread_external_id": None
},
"principal": "<string>",
"session_id": "<unknown>",
"agent": "<unknown>",
"agent_deployment_revision_selection": "<unknown>",
"mounts": "<unknown>",
"acted_as": "<unknown>",
"caused_by": "<unknown>",
"harness": "<unknown>",
"model_routing_profile_key": "<unknown>",
"sandbox_profile_key": "<unknown>"
}
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>',
agent_installation_id: '<string>',
surface_scope_id: '<string>',
conversation: {root_external_id: '<string>', thread_external_id: null},
principal: '<string>',
session_id: '<unknown>',
agent: '<unknown>',
agent_deployment_revision_selection: '<unknown>',
mounts: '<unknown>',
acted_as: '<unknown>',
caused_by: '<unknown>',
harness: '<unknown>',
model_routing_profile_key: '<unknown>',
sandbox_profile_key: '<unknown>'
})
};
fetch('https://api.checkfu.com/v1/conversation-bindings/resolve', 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/resolve",
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>',
'agent_installation_id' => '<string>',
'surface_scope_id' => '<string>',
'conversation' => [
'root_external_id' => '<string>',
'thread_external_id' => null
],
'principal' => '<string>',
'session_id' => '<unknown>',
'agent' => '<unknown>',
'agent_deployment_revision_selection' => '<unknown>',
'mounts' => '<unknown>',
'acted_as' => '<unknown>',
'caused_by' => '<unknown>',
'harness' => '<unknown>',
'model_routing_profile_key' => '<unknown>',
'sandbox_profile_key' => '<unknown>'
]),
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/resolve"
payload := strings.NewReader("{\n \"external_installation_id\": \"<string>\",\n \"agent_installation_id\": \"<string>\",\n \"surface_scope_id\": \"<string>\",\n \"conversation\": {\n \"root_external_id\": \"<string>\",\n \"thread_external_id\": null\n },\n \"principal\": \"<string>\",\n \"session_id\": \"<unknown>\",\n \"agent\": \"<unknown>\",\n \"agent_deployment_revision_selection\": \"<unknown>\",\n \"mounts\": \"<unknown>\",\n \"acted_as\": \"<unknown>\",\n \"caused_by\": \"<unknown>\",\n \"harness\": \"<unknown>\",\n \"model_routing_profile_key\": \"<unknown>\",\n \"sandbox_profile_key\": \"<unknown>\"\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/resolve")
.header("checkfu-version", "<checkfu-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"external_installation_id\": \"<string>\",\n \"agent_installation_id\": \"<string>\",\n \"surface_scope_id\": \"<string>\",\n \"conversation\": {\n \"root_external_id\": \"<string>\",\n \"thread_external_id\": null\n },\n \"principal\": \"<string>\",\n \"session_id\": \"<unknown>\",\n \"agent\": \"<unknown>\",\n \"agent_deployment_revision_selection\": \"<unknown>\",\n \"mounts\": \"<unknown>\",\n \"acted_as\": \"<unknown>\",\n \"caused_by\": \"<unknown>\",\n \"harness\": \"<unknown>\",\n \"model_routing_profile_key\": \"<unknown>\",\n \"sandbox_profile_key\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.checkfu.com/v1/conversation-bindings/resolve")
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 \"agent_installation_id\": \"<string>\",\n \"surface_scope_id\": \"<string>\",\n \"conversation\": {\n \"root_external_id\": \"<string>\",\n \"thread_external_id\": null\n },\n \"principal\": \"<string>\",\n \"session_id\": \"<unknown>\",\n \"agent\": \"<unknown>\",\n \"agent_deployment_revision_selection\": \"<unknown>\",\n \"mounts\": \"<unknown>\",\n \"acted_as\": \"<unknown>\",\n \"caused_by\": \"<unknown>\",\n \"harness\": \"<unknown>\",\n \"model_routing_profile_key\": \"<unknown>\",\n \"sandbox_profile_key\": \"<unknown>\"\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": "model.no_eligible_model",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#model-no-eligible-model"
}
}{
"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"
}
}Resolve a ConversationBinding for a conversation
The live ingress call: create-or-return the ConversationBinding for one canonical provider conversation under an active AgentInstallation, and return the session_id to drive. Session identity is derived from the Workspace, ExternalInstallation, and complete conversation key, so simultaneous first messages in a fresh thread converge on one Session instead of forking. Caller-supplied Session or deployment coordinates, acted_as, caused_by, runtime profile keys, or mounts are rejected rather than ignored, because installed admission derives every one of them.
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
/
v1
/
conversation-bindings
/
resolve
Resolve a ConversationBinding for a conversation
curl --request POST \
--url https://api.checkfu.com/v1/conversation-bindings/resolve \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'checkfu-version: <checkfu-version>' \
--data '
{
"external_installation_id": "<string>",
"agent_installation_id": "<string>",
"surface_scope_id": "<string>",
"conversation": {
"root_external_id": "<string>",
"thread_external_id": null
},
"principal": "<string>",
"session_id": "<unknown>",
"agent": "<unknown>",
"agent_deployment_revision_selection": "<unknown>",
"mounts": "<unknown>",
"acted_as": "<unknown>",
"caused_by": "<unknown>",
"harness": "<unknown>",
"model_routing_profile_key": "<unknown>",
"sandbox_profile_key": "<unknown>"
}
'import requests
url = "https://api.checkfu.com/v1/conversation-bindings/resolve"
payload = {
"external_installation_id": "<string>",
"agent_installation_id": "<string>",
"surface_scope_id": "<string>",
"conversation": {
"root_external_id": "<string>",
"thread_external_id": None
},
"principal": "<string>",
"session_id": "<unknown>",
"agent": "<unknown>",
"agent_deployment_revision_selection": "<unknown>",
"mounts": "<unknown>",
"acted_as": "<unknown>",
"caused_by": "<unknown>",
"harness": "<unknown>",
"model_routing_profile_key": "<unknown>",
"sandbox_profile_key": "<unknown>"
}
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>',
agent_installation_id: '<string>',
surface_scope_id: '<string>',
conversation: {root_external_id: '<string>', thread_external_id: null},
principal: '<string>',
session_id: '<unknown>',
agent: '<unknown>',
agent_deployment_revision_selection: '<unknown>',
mounts: '<unknown>',
acted_as: '<unknown>',
caused_by: '<unknown>',
harness: '<unknown>',
model_routing_profile_key: '<unknown>',
sandbox_profile_key: '<unknown>'
})
};
fetch('https://api.checkfu.com/v1/conversation-bindings/resolve', 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/resolve",
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>',
'agent_installation_id' => '<string>',
'surface_scope_id' => '<string>',
'conversation' => [
'root_external_id' => '<string>',
'thread_external_id' => null
],
'principal' => '<string>',
'session_id' => '<unknown>',
'agent' => '<unknown>',
'agent_deployment_revision_selection' => '<unknown>',
'mounts' => '<unknown>',
'acted_as' => '<unknown>',
'caused_by' => '<unknown>',
'harness' => '<unknown>',
'model_routing_profile_key' => '<unknown>',
'sandbox_profile_key' => '<unknown>'
]),
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/resolve"
payload := strings.NewReader("{\n \"external_installation_id\": \"<string>\",\n \"agent_installation_id\": \"<string>\",\n \"surface_scope_id\": \"<string>\",\n \"conversation\": {\n \"root_external_id\": \"<string>\",\n \"thread_external_id\": null\n },\n \"principal\": \"<string>\",\n \"session_id\": \"<unknown>\",\n \"agent\": \"<unknown>\",\n \"agent_deployment_revision_selection\": \"<unknown>\",\n \"mounts\": \"<unknown>\",\n \"acted_as\": \"<unknown>\",\n \"caused_by\": \"<unknown>\",\n \"harness\": \"<unknown>\",\n \"model_routing_profile_key\": \"<unknown>\",\n \"sandbox_profile_key\": \"<unknown>\"\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/resolve")
.header("checkfu-version", "<checkfu-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"external_installation_id\": \"<string>\",\n \"agent_installation_id\": \"<string>\",\n \"surface_scope_id\": \"<string>\",\n \"conversation\": {\n \"root_external_id\": \"<string>\",\n \"thread_external_id\": null\n },\n \"principal\": \"<string>\",\n \"session_id\": \"<unknown>\",\n \"agent\": \"<unknown>\",\n \"agent_deployment_revision_selection\": \"<unknown>\",\n \"mounts\": \"<unknown>\",\n \"acted_as\": \"<unknown>\",\n \"caused_by\": \"<unknown>\",\n \"harness\": \"<unknown>\",\n \"model_routing_profile_key\": \"<unknown>\",\n \"sandbox_profile_key\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.checkfu.com/v1/conversation-bindings/resolve")
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 \"agent_installation_id\": \"<string>\",\n \"surface_scope_id\": \"<string>\",\n \"conversation\": {\n \"root_external_id\": \"<string>\",\n \"thread_external_id\": null\n },\n \"principal\": \"<string>\",\n \"session_id\": \"<unknown>\",\n \"agent\": \"<unknown>\",\n \"agent_deployment_revision_selection\": \"<unknown>\",\n \"mounts\": \"<unknown>\",\n \"acted_as\": \"<unknown>\",\n \"caused_by\": \"<unknown>\",\n \"harness\": \"<unknown>\",\n \"model_routing_profile_key\": \"<unknown>\",\n \"sandbox_profile_key\": \"<unknown>\"\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": "model.no_eligible_model",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#model-no-eligible-model"
}
}{
"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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Available options:
2026-08-24 Maximum string length:
255Body
application/json
Pattern:
^exti_[0-9a-f]{32}$Pattern:
^aini_[0-9a-f]{32}$Pattern:
^surf_[0-9a-f]{32}$- Option 1
- Option 2
Show child attributes
Show child attributes
Pattern:
^prin_[0-9a-f]{32}$Show child attributes
Show child attributes
Response
Success
Pattern:
^conv_[0-9a-f]{32}$Pattern:
^wrkspc_[0-9a-f]{32}$Pattern:
^exti_[0-9a-f]{32}$Pattern:
^surf_[0-9a-f]{32}$- Option 1
- Option 2
Show child attributes
Show child attributes
Pattern:
^sess_[0-9a-f]{32}$Available options:
active, replaced, archived Pattern:
^conv_[0-9a-f]{32}$Required string length:
1 - 512Required string length:
1 - 512Pattern:
^aini_[0-9a-f]{32}$Show child attributes
Show child attributes
Required range:
x > 0