Chat Transcript

Retrieve the full conversation transcript for any chat session in your application. This is useful for logging conversations, syncing chat data to your CRM, or building analytics on top of your Chipp app.

Endpoint

GET https://build.chipp.ai/api/v1/chat/transcript/{sessionId}

Authentication

Include your application’s API key as a Bearer token:

Authorization: Bearer YOUR_API_KEY

This is the same API key used for the Chat Completions API. The key must have read access to Sessions. Keys created without custom permissions have it.

Path Parameters

Example Request

curl https://build.chipp.ai/api/v1/chat/transcript/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

Success (200)

{
  "sessionId": "550e8400-e29b-41d4-a716-446655440000",
  "title": "Conversation about pricing",
  "messageCount": 6,
  "userMessageCount": 3,
  "botMessageCount": 3,
  "messages": [
    {
      "role": "user",
      "content": "Hi, I have a question about your pricing plans.",
      "timestamp": "2026-01-15T10:30:00.000Z"
    },
    {
      "role": "assistant",
      "content": "Of course! I'd be happy to help with pricing. What would you like to know?",
      "timestamp": "2026-01-15T10:30:02.000Z"
    }
  ],
  "truncated": false,
  "encrypted": false,
  "zeroDataRetention": false,
  "createdAt": "2026-01-15T10:29:55.000Z",
  "updatedAt": "2026-01-15T10:35:12.000Z"
}

Response Fields

Internal messages (system prompts, tool calls and results, and conversation summaries Chipp makes to fit long chats into the model’s context) are not part of the transcript.

Encrypted Sessions

If the end user’s conversation is end-to-end encrypted, only that user can read it. The transcript keeps the roles, timestamps, and counts, and each content is the placeholder "[Encrypted - only visible to the consumer]". This matches the Builder API sessions endpoints.

Zero Data Retention

With Zero Data Retention on, Chipp never stores message content, so messages is empty and all counts are 0. The session itself (title and timestamps) is still returned. This matches the Builder API sessions endpoints.

Error Responses

Authentication Failed (401)

{ "error": "Missing API key" }

No Authorization header provided.

{ "error": "Invalid API key" }

The API key is incorrect, revoked, expired, or doesn’t belong to any application.

Missing Permission (403)

{ "error": "API key does not have read access to sessions" }

The key was created with custom permissions that do not include Sessions.

Session Not Found (404)

{ "error": "Session not found" }

The session ID doesn’t exist, isn’t a valid UUID, or doesn’t belong to your application. For security, the same error is returned in all three cases.

Rate Limit Exceeded (429)

{ "error": "Rate limit exceeded" }

More than 120 transcript requests in one minute with the same API key. Wait for the number of seconds in the Retry-After header. This limit is separate from the Chat Completions limit, so reading transcripts does not slow down your chats.

Server Error (500)

{ "error": "Failed to fetch session" }

Common Use Cases

Webhook Integration

If your Chipp app uses a custom action to send data to a webhook, you can include the session ID in the webhook payload and then fetch the full transcript from your backend:

# Your webhook handler receives the session ID
session_id = webhook_payload["chatSessionId"]

# Fetch the full transcript
import requests

response = requests.get(
    f"https://build.chipp.ai/api/v1/chat/transcript/{session_id}",
    headers={"Authorization": "Bearer YOUR_API_KEY"}
)
transcript = response.json()

# Store or process the transcript
for message in transcript["messages"]:
    print(f"{message['role']}: {message['content']}")

CRM Sync

After a conversation ends, fetch the transcript and attach it to a contact record in your CRM:

const response = await fetch(
  `https://build.chipp.ai/api/v1/chat/transcript/${sessionId}`,
  {
    headers: { Authorization: `Bearer ${process.env.CHIPP_API_KEY}` },
  }
);

const { messages, messageCount } = await response.json();

// Format for CRM note
const note = messages
  .map((m) => `${m.role === "user" ? "Customer" : "Bot"}: ${m.content}`)
  .join("\n\n");

Security

• Each API key is scoped to a single application. You can only retrieve transcripts for sessions that belong to your application.
• Attempting to access a session from a different application returns a 404 (not 403) to prevent leaking information about session existence.
• For paginated message lists with tags, feedback, and tool details, use the Builder API sessions endpoints (GET /api/v1/apps/{appId}/sessions/{sessionId}/messages).