Get Conversation

Python

import os
from channel3_sdk import Channel3

client = Channel3(
    api_key=os.environ.get("CHANNEL3_API_KEY"),  # This is the default and can be omitted
)
conversation_detail = client.conversations.retrieve(
    conversation_id="conversation_id",
)
print(conversation_detail.id)

import Channel3 from '@channel3/sdk';

const client = new Channel3({
  apiKey: process.env['CHANNEL3_API_KEY'], // This is the default and can be omitted
});

const conversationDetail = await client.conversations.retrieve('conversation_id');

console.log(conversationDetail.id);

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

import os
from channel3_sdk import Channel3

client = Channel3(
    api_key=os.environ.get("CHANNEL3_API_KEY"),  # This is the default and can be omitted
)
conversation_detail = client.conversations.retrieve(
    conversation_id="conversation_id",
)
print(conversation_detail.id)

import Channel3 from '@channel3/sdk';

const client = new Channel3({
  apiKey: process.env['CHANNEL3_API_KEY'], // This is the default and can be omitted
});

const conversationDetail = await client.conversations.retrieve('conversation_id');

console.log(conversationDetail.id);

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

Models

Authorizations

Path Parameters

Query Parameters

Response