POpoll-the-people
Message

Get message details.

Changed on

Returns the complete details for a single message, including the user's prompt, the agent's response, timestamps, citations, and any attached metadata. Use this to retrieve specific messages for display or analysis.

get/api/v1/projects/{projectId}/conversations/{sessionId}/messages/{promptId}

Request

Path parameters

projectIdinteger required
Example:1

The ID of the agent to get the messages for

sessionIdstring required
Example:1

The session ID of the conversation to get the messages for

promptIdinteger required

The unique identifier of the message to retrieve. Obtain message IDs from GET /api/v1/projects/{projectId}/conversations/{sessionId}/messages.

Query parameters

includeInsightsboolean
Example:true

When true, includes customer_intelligence data in the response. Only has an effect if the lead capture feature is enabled for this agent.

Response

Retrieve certain conversation message

status'error' | 'success'

The status of the response

Example response

{
  "status": "success",
  "data": {
    "id": 101,
    "conversation_id": 42,
    "user_id": 1,
    "user_query": "What file formats does CustomGPT support?",
    "openai_response": "CustomGPT supports PDF, DOCX, TXT, and more. You can also ingest content via sitemap, URL, or file upload.",
    "citations": [
      3,
      7
    ],
    "citations_external": [
      {
        "source_id": "1-1",
        "type": "web",
        "action": "web_search",
        "title": "Paris - Wikipedia",
        "url": "https://en.wikipedia.org/wiki/Paris",
        "description": "Paris is the capital of France."
      }
    ],
    "citations_hidden": [
      12
    ],
    "tools": [],
    "metadata": {
      "user_ip": "203.0.113.12",
      "user_agent": "Mozilla/5.0",
      "external_id": "ext_id_abc123",
      "request_source": "web"
    },
    "response_feedback": {
      "created_at": "2024-08-27T21:07:20.000000Z",
      "updated_at": "2024-08-27T21:07:20.000000Z",
      "user_id": 1,
      "reaction": "liked"
    },
    "customer_intelligence": {
      "prompt_id": 101,
      "conversation_id": 42,
      "project_id": 7,
      "user_query": "What file formats does CustomGPT support?",
      "ai_response": "CustomGPT supports PDF, DOCX, TXT, and more.",
      "created_at": "2026-02-01T09:20:00.000000Z",
      "content_source": "in-context",
      "user_emotion": "neutral",
      "user_intent": "informational",
      "language": "en",
      "human_request": "false",
      "user_id": -2,
      "user_location": "US",
      "chatbot_deployment": "web",
      "risk_fidelity": "Good",
      "risk_jailbreak": "no_event",
      "risk_prompt_leakage": "no_event",
      "risk_profanity": "no_event",
      "accuracy": "-",
      "stakeholder_status": "UNKNOWN",
      "browser": "Chrome 121"
    },
    "created_at": "2026-02-01T09:20:00.000000Z",
    "updated_at": "2026-02-01T09:20:05.000000Z"
  }
}

Changes

  • 77aab4354382Revision changes
    • breaking

      the response property / became nullable for the status

    • warning

      added the new 422.00 enum value to the / response property for the response status

    • warning

      added the new 422.00 enum value to the / response property for the response status

    • warning

      added the new 422.00 enum value to the / response property for the response status

    • warning

      added the new 422.00 enum value to the / response property for the response status

    • warning

      added the new disliked enum value to the // response property for the response status

    • warning

      added the new liked enum value to the // response property for the response status

    • warning

      added the new neutral enum value to the // response property for the response status

    • info

      added the new optional query request parameter includeInsights

    • info

      added the non-success 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

    • info

      added the optional property / to the response with the status

    • info

      removed the neutral disliked liked enum value from the // response property for the response status

  • b80e6dfcf78dRevision changes
    • info

      endpoint added