context

Retrieve user context

Gets the context information for the authenticated user.

get/api/v1/context/view

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

Changed in 6 of the 29 revisions of this API.114

    • removed the optional property context from the response with the 200 status

      response-optional-property-removed

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

      response-media-type-added

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

      response-media-type-added

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

      response-media-type-added

    • added the required property contexts to the response with the 200 status

      response-required-property-added

    • added the required property success to the response with the 200 status

      response-required-property-added

    • api operation id viewRawContextNodesForUser was added

      api-operation-id-added

    • added the new optional query request parameter file_name

      new-optional-request-parameter

    • added the new optional query request parameter magic_key

      new-optional-request-parameter

    • the endpoint scheme security bearerAuth was added to the API

      api-security-added

    • the endpoint scheme security BearerAuth was removed from the API

      api-security-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the endpoint scheme security BearerAuth was added to the API

      api-security-added

    • the endpoint scheme security bearerAuth was removed from the API

      api-security-removed

    • the endpoint scheme security bearerAuth was added to the API

      api-security-added

    • the endpoint scheme security BearerAuth was removed from the API

      api-security-removed