context

Retrieve user context

Changed on

Gets the context information for the authenticated user.

get/api/v1/context/view

Request

Query parameters

file_namestring

Name of the file to retrieve context for

magic_keystring

Magic key for context retrieval

Response

Successfully retrieved context

successboolean required

Example response

{
  "success": true,
  "contexts": [
    {
      "content": "Customer asked about pricing for the Scale plan.",
      "metadata": {
        "fileName": "support_thread_TCK-1234.txt",
        "fileType": "text/plain",
        "groupName": [
          "support",
          "pricing"
        ],
        "lastModified": "2025-01-10T12:34:56.000Z",
        "fileSize": 2048
      }
    }
  ]
}

Changes

    • warning

      removed the optional property from the response with the status

    • info

      api operation id viewRawContextNodesForUser was added

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      api operation id viewRawContextNodesForUser removed and replaced with

    • info

      added the optional property to the response with the status