OpenAI Analytics icon

OpenAI Analytics

Use OpenAI Analytics API

Actions20

Thread → Get Thread

AI-generated

Overview

The "Get Thread" operation in the OpenAI Analytics node allows users to retrieve detailed information about a specific conversation thread by its ID. This is useful for scenarios where you want to fetch the current state or details of an ongoing or completed thread interaction with an assistant, such as reviewing messages, status, or metadata associated with that thread.

Practical examples include:

  • Fetching a thread to display conversation history in a dashboard.
  • Retrieving thread details to analyze user interactions or debug issues.
  • Integrating thread data into workflows that depend on previous conversation context.

Properties

Name Meaning
Authentication Choose which API credentials to use: either dedicated OpenAI Analytics API credentials or existing OpenAI API credentials. Options: "OpenAI Analytics API", "OpenAI API".

For the Get Thread operation specifically (inferred from the bundled code and property definitions), the following input properties are relevant:

Name Meaning
Thread ID The unique identifier of the thread to retrieve. Required to specify which thread to get.
Authentication Selects which set of API credentials to use for the request.

Note: The full node supports many other properties for different resources and operations, but for "Get Thread" only the above are applicable.

Output

The output of the "Get Thread" operation is a JSON object representing the thread's details as returned by the OpenAI Analytics API. This typically includes:

  • Thread metadata such as ID, creation time, status.
  • Messages within the thread.
  • Associated assistant or user information.
  • Any additional data related to the thread's execution or results.

The exact structure depends on the API response but generally provides comprehensive information about the thread.

The node does not output binary data for this operation.

Dependencies

  • Requires valid API credentials for either:

    • OpenAI Analytics API (dedicated analytics credentials).
    • OpenAI API (existing general-purpose credentials).

  • The node uses the official OpenAI SDK (openai npm package) to communicate with the API.

  • No additional external services are required beyond OpenAI.

  • Proper configuration of credentials in n8n is necessary to authenticate requests.

Troubleshooting

Common Issues

  • Invalid or missing Thread ID: The operation requires a valid thread ID; omitting or providing an incorrect ID will cause errors.
  • Authentication errors: Using invalid or expired API keys will result in authentication failures.
  • API rate limits: Exceeding OpenAI API rate limits may cause request failures.
  • Network issues: Connectivity problems can prevent successful API calls.

Error Messages and Resolutions

  • "Error loading credentials": Indicates failure to load the selected API credentials. Verify that credentials are correctly configured in n8n.
  • "Unsupported resource: thread": Occurs if the resource parameter is incorrectly set. Ensure the resource is set to "thread".
  • API error responses (e.g., 404 Not Found): Usually mean the specified thread ID does not exist or is inaccessible. Double-check the thread ID.
  • Timeout or polling errors: If waiting for thread completion, ensure the maximum poll time is sufficient and network connectivity is stable.

Links and References

This summary focuses on the "Get Thread" operation of the OpenAI Analytics node, describing its purpose, inputs, outputs, dependencies, and common troubleshooting tips based on static analysis of the provided source code and property definitions.

Discussion