Get agent conversation

Changed on

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Returns one conversation with one of the app's agents, with its most recent messages.

The messages are what the app's user and the agent wrote, so they can hold personal data. They also include what the agent's tools returned.

This is limited to 120 requests a minute per app for each workspace's personal API keys, so every key in a workspace shares one allowance. Some workspaces have a different limit.

<Note>This endpoint accepts a personal API key, including a read-only one, from anyone with access to the app, viewers included. Workspace API keys are not authorized for it.</Note>

get/api/apps/{app_id}/agent-configs/conversations/{conversation_id}

Request

  • Base URL: https://app.base44.com
  • URL: https://app.base44.com/api/apps/{app_id}/agent-configs/conversations/{conversation_id}
  • Auth: HTTP bearer

Path parameters

conversation_idstring required

ID of the conversation. Get this from List agent conversation users.

app_idstring required

ID of the app whose agents to read.

Response

The conversation and its most recent messages.

idstring required

ID of the conversation.

app_idstring required

ID of the app.

agent_namestring required

Name of the agent the conversation is with.

created_by_idstring nullable

ID of the app user who started the conversation. An anonymous visitor's conversation carries anonymous, guest, an empty string, or null instead.

created_by_emailstring nullable

Email of the app user who started the conversation, or null for an anonymous visitor or an app user who no longer exists.

metadataobject

Free-form data stored with the conversation. It holds whatever the app set when it created the conversation, plus channel details such as a WhatsApp user's phone number.

message_countinteger

Number of messages in the conversation.

credit_countnumber

Credits charged for the agent's replies in the conversation.

answeringstring

Who answers the next customer message: ai (the agent), human (the app owner stepped in or replied from their own WhatsApp Business phone), or escalated (the agent asked for the owner and is waiting).

answering_versioninteger

Version of the answering mode. Send it back as expected_version when changing the mode.

human_untilstring date-time nullable

When a hold taken from the owner's own phone ends and the agent resumes, or null while the owner has stepped in.

escalation_summarystring nullable

Why the agent asked for the owner, when it did.

created_datestring date-time nullable

When the conversation was created, as a UTC timestamp in ISO 8601 format.

updated_datestring date-time nullable

When the conversation was last updated, as a UTC timestamp in ISO 8601 format.

Example response

{
  "id": "68a1d2c3e4f5061728394a5b",
  "app_id": "6820f3a4e7b91d003c45a1f2",
  "agent_name": "support_agent",
  "created_by_id": "68a1d2c3e4f5061728394a6c",
  "created_by_email": "jane@acme.com",
  "metadata": {
    "name": "Order #1042 delivery date"
  },
  "messages": [
    {
      "content": "When will order #1042 arrive?",
      "hidden": false,
      "id": "4f1c2a9e-7b3d-4e8a-9c21-5d6f7a8b9c0d",
      "role": "user"
    },
    {
      "content": "Your order ships tomorrow and should arrive by Friday.",
      "hidden": false,
      "id": "8a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "role": "assistant"
    }
  ],
  "message_count": 6,
  "credit_count": 1.5,
  "answering": "ai",
  "answering_version": 1,
  "created_date": "2026-01-15T09:23:41",
  "updated_date": "2026-01-15T09:31:07"
}

Changes

  • f25dc342541aRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 5e139db2e643Revision changes
    • info

      the endpoint scheme security PersonalAccessTokenAuth was added to the API