Get Conversation

Python

from channel3_sdk import Channel3
from channel3_sdk.environment import Channel3Environment

client = Channel3(
    api_key="<value>",
    environment=Channel3Environment.PRODUCTION,
)

client.conversations.retrieve(
    conversation_id="conversation_id",
)

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

fetch('https://api.trychannel3.com/v1/conversations/{conversation_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "<string>",
  "created_at": 123,
  "items": [
    {
      "role": "user",
      "parts": [
        {
          "text": "<string>",
          "type": "text"
        }
      ]
    }
  ],
  "user_id": "<string>",
  "context": {
    "user_context": "<string>",
    "application_context": "<string>"
  },
  "next_cursor": "<string>",
  "has_more": false
}

GET

conversations

{conversation_id}

Python

from channel3_sdk import Channel3
from channel3_sdk.environment import Channel3Environment

client = Channel3(
    api_key="<value>",
    environment=Channel3Environment.PRODUCTION,
)

client.conversations.retrieve(
    conversation_id="conversation_id",
)

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

fetch('https://api.trychannel3.com/v1/conversations/{conversation_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "<string>",
  "created_at": 123,
  "items": [
    {
      "role": "user",
      "parts": [
        {
          "text": "<string>",
          "type": "text"
        }
      ]
    }
  ],
  "user_id": "<string>",
  "context": {
    "user_context": "<string>",
    "application_context": "<string>"
  },
  "next_cursor": "<string>",
  "has_more": false
}

See Read a conversation.

Authorizations

x-api-key

string

header

required

Path Parameters

conversation_id

string

required

Query Parameters

limit

integer

default:50

Required range: 1 <= x <= 200

cursor

string | null

Response

Successful Response

Thread metadata plus one page of its message history.

string

required

created_at

integer

required

items

(UserMessage · object | AssistantMessage · object)[]

required

UserMessage
AssistantMessage

Show child attributes

user_id

string | null

context

ConversationContext · object | null

Partner-supplied context pinned to the top of a conversation thread.

Show child attributes

next_cursor

string | null

Pass as cursor to fetch the next page. Null when no more items.

has_more

boolean

default:false

Products

Conversational Agent

Collections

Brands

Categories

Websites

Reporting

Price & Availability

Models

Authorizations

Path Parameters

Query Parameters

Response