Get a v2 conversation with recent turns

GET

conversations

{conversation_id}

curl --request GET \
  --url https://api-sandbox.featherhq.com/v1/conversations/{conversation_id} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api-sandbox.featherhq.com/v1/conversations/{conversation_id}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api-sandbox.featherhq.com/v1/conversations/{conversation_id}', 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-sandbox.featherhq.com/v1/conversations/{conversation_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api-sandbox.featherhq.com/v1/conversations/{conversation_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.featherhq.com/v1/conversations/{conversation_id}")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "end_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "channel": "<string>",
  "surface": "<string>",
  "status": "queued",
  "priority": "low",
  "message_count": 123,
  "started_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "external_session_id": "<string>",
  "session_type": "live",
  "subject": "<string>",
  "assigned_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "retention_policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "summary": "<string>",
  "metadata": {},
  "context_variables": {},
  "first_message_at": "2023-11-07T05:31:56Z",
  "last_message_at": "2023-11-07T05:31:56Z",
  "ended_at": "2023-11-07T05:31:56Z",
  "closed_at": "2023-11-07T05:31:56Z",
  "ttl_expires_at": "2023-11-07T05:31:56Z",
  "retention_expires_at": "2023-11-07T05:31:56Z",
  "archived_at": "2023-11-07T05:31:56Z",
  "memory_sync_state": "pending",
  "duration_ms": 123,
  "summary_preview": "<string>",
  "has_recording": false,
  "eval_summary": {
    "total": 0,
    "succeeded": 0,
    "failed": 0,
    "pending": 0,
    "critical_total": 0,
    "critical_succeeded": 0,
    "critical_failed": 0,
    "critical_pending": 0,
    "eval_status": "none"
  },
  "test_features": {
    "identity_resolution": true,
    "memory": true,
    "summarization": true,
    "extraction": true,
    "evaluations": true,
    "knowledge_gap_analysis": true,
    "version": 1
  },
  "revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "revision_name": "<string>",
  "revision_version": 123,
  "team_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "team_revision_name": "<string>",
  "from_number": "<string>",
  "to_number": "<string>",
  "email": "<string>",
  "recent_turns": [],
  "recording_url": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

x-api-key

string

header

required

Path Parameters

conversation_id

string<uuid>

required

Response

Successful Response

string<uuid>

required

organization_id

string<uuid>

required

end_user_id

string<uuid>

required

channel

string

required

surface

string

required

status

enum<string>

required

Available options:

queued,

ringing,

active,

paused,

waiting_for_human,

transferred,

awaiting_approval,

pending_dispatch,

closed,

expired,

error,

superseded

priority

enum<string>

required

Available options:

low,

normal,

high,

urgent

message_count

integer

required

started_at

string<date-time>

required

created_at

string<date-time>

required

updated_at

string<date-time>

required

external_session_id

string | null

session_type

enum<string>

default:live

Available options:

live,

test,

simulation

subject

string | null

assigned_agent_id

string<uuid> | null

retention_policy_id

string<uuid> | null

summary

string | null

metadata

Metadata · object

context_variables

Context Variables · object

first_message_at

string<date-time> | null

last_message_at

string<date-time> | null

ended_at

string<date-time> | null

closed_at

string<date-time> | null

ttl_expires_at

string<date-time> | null

retention_expires_at

string<date-time> | null

archived_at

string<date-time> | null

memory_sync_state

enum<string>

default:pending

Available options:

pending,

synced,

skipped,

suppressed

duration_ms

integer | null

summary_preview

string | null

has_recording

boolean

default:false

eval_summary

SessionEvalSummary · object

Rollup of eval runs that targeted a session.

succeeded = runs where status='completed' AND every score has passed=true. failed = total - succeeded - pending (failed-status runs + completed-but-not-all-passed). pending = runs still queued or running.

The critical_* counterparts restrict the same aggregation to runs whose binding was marked is_critical=True (snapshotted onto the run). They drive the session headline pill — non-critical evals still run and display but don't move the verdict. eval_status collapses the critical counts to a single headline label (none when no criticals are configured).

Show child attributes

test_features

TestSessionFeatures · object | null

Resolved, immutable snapshot persisted on a test conversation.

Show child attributes

revision_id

string<uuid> | null

revision_name

string | null

revision_version

integer | null

team_revision_id

string<uuid> | null

team_revision_name

string | null

from_number

string | null

to_number

string | null

recent_turns

TurnResponse · object[]

Show child attributes

recording_url

string | null

Get a v2 conversation with recent turns

curl --request GET \
  --url https://api-sandbox.featherhq.com/v1/conversations/{conversation_id} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api-sandbox.featherhq.com/v1/conversations/{conversation_id}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api-sandbox.featherhq.com/v1/conversations/{conversation_id}', 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-sandbox.featherhq.com/v1/conversations/{conversation_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api-sandbox.featherhq.com/v1/conversations/{conversation_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.featherhq.com/v1/conversations/{conversation_id}")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "end_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "channel": "<string>",
  "surface": "<string>",
  "status": "queued",
  "priority": "low",
  "message_count": 123,
  "started_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "external_session_id": "<string>",
  "session_type": "live",
  "subject": "<string>",
  "assigned_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "retention_policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "summary": "<string>",
  "metadata": {},
  "context_variables": {},
  "first_message_at": "2023-11-07T05:31:56Z",
  "last_message_at": "2023-11-07T05:31:56Z",
  "ended_at": "2023-11-07T05:31:56Z",
  "closed_at": "2023-11-07T05:31:56Z",
  "ttl_expires_at": "2023-11-07T05:31:56Z",
  "retention_expires_at": "2023-11-07T05:31:56Z",
  "archived_at": "2023-11-07T05:31:56Z",
  "memory_sync_state": "pending",
  "duration_ms": 123,
  "summary_preview": "<string>",
  "has_recording": false,
  "eval_summary": {
    "total": 0,
    "succeeded": 0,
    "failed": 0,
    "pending": 0,
    "critical_total": 0,
    "critical_succeeded": 0,
    "critical_failed": 0,
    "critical_pending": 0,
    "eval_status": "none"
  },
  "test_features": {
    "identity_resolution": true,
    "memory": true,
    "summarization": true,
    "extraction": true,
    "evaluations": true,
    "knowledge_gap_analysis": true,
    "version": 1
  },
  "revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "revision_name": "<string>",
  "revision_version": 123,
  "team_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "team_revision_name": "<string>",
  "from_number": "<string>",
  "to_number": "<string>",
  "email": "<string>",
  "recent_turns": [],
  "recording_url": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}