OpenAI Analytics icon

OpenAI Analytics

Use OpenAI Analytics API

Actions20

Thread → Check Run Status

AI-generated

Overview

The "Check Run Status" operation of the "Thread" resource in this OpenAI Analytics node allows users to query the current status of a specific run within a thread. This is useful for monitoring asynchronous or long-running processes initiated by running threads, enabling workflows to wait for completion or handle intermediate states accordingly.

Typical use cases include:

  • Polling the status of an AI assistant's task execution to determine if it has completed.
  • Integrating with workflows that require conditional logic based on whether a thread run is finished.
  • Debugging or auditing thread runs by retrieving their current state.

For example, after starting a thread run, you can periodically check its status using this operation until it completes, then proceed with further processing.

Properties

Name Meaning
Authentication Choose which API credentials to use: either dedicated OpenAI Analytics API or existing OpenAI API credentials.
Thread ID The unique identifier of the thread whose run status you want to check. (Required)
Run ID The unique identifier of the specific run within the thread to check the status for. (Required)

Output

The output JSON contains the status information of the specified run within the thread. It typically includes fields such as the current state of the run (e.g., running, completed, failed), timestamps, and any relevant metadata about the run's progress or result.

If the node supports binary data output for other operations, it is not applicable here since this operation deals with status checking and returns structured JSON data only.

Dependencies

  • Requires valid API authentication via either:
    • Dedicated OpenAI Analytics API credentials, or
    • Existing OpenAI API credentials.
  • The node internally uses the OpenAI client library to communicate with the OpenAI Analytics API endpoints.
  • No additional external services are required beyond OpenAI APIs.
  • Proper configuration of API keys and optional organization IDs or base URLs in n8n credentials is necessary.

Troubleshooting

  • Common Issues:
    • Invalid or missing Thread ID or Run ID parameters will cause errors.
    • Using incorrect or expired API credentials may lead to authentication failures.
    • Network issues or API rate limits could cause request failures or timeouts.
  • Error Messages:
    • "Unsupported resource: thread" — indicates the resource parameter was set incorrectly; ensure it is exactly "thread".
    • Credential loading errors — verify that the API key credentials are correctly configured in n8n.
    • API response errors — check the validity of Thread ID and Run ID; confirm the run exists and is accessible.
  • Resolution Tips:
    • Double-check input parameters for correctness and completeness.
    • Ensure API credentials have sufficient permissions.
    • Handle errors gracefully by enabling "Continue On Fail" in the node settings if appropriate.

Links and References

(Note: The above links are general references as the exact API endpoint details are abstracted in the node code.)

Discussion