Opik icon

Opik

Interact with the Opik API
Join our community

Actions6

Overview

This node interacts with the Opik API to create a new trace within a specified project. It is useful for tracking and grouping related operations or events in a project, allowing users to add input data, metadata, tags, and options such as trace name and thread ID. For example, it can be used to start a trace for monitoring a process flow or debugging purposes, with the ability to auto-end the trace immediately after creation if desired.

Use Case Examples

  1. Creating a trace with custom input and metadata to monitor a specific operation in a project.
  2. Grouping related traces using the same thread ID for easier correlation and analysis.
  3. Tagging traces for filtering and organization within the Opik platform.

Properties

Name Meaning
Project Name or ID Specifies the project in which the trace will be created. Can be selected from a list or specified by ID.
Input Input data entries to be included in the trace, specified as key-value assignments.
Resolved Input Hidden property that resolves the input assignments into an object to be sent in the request body.
Resolved Thread ID Hidden property that resolves or generates a thread ID to group related traces.
Metadata Metadata entries to be included in the trace, specified as key-value assignments.
Resolved Metadata Hidden property that resolves the metadata assignments into an object to be sent in the request body.
Options Additional options for the trace such as trace name override, thread ID, and whether to auto-end the trace immediately after creation.
Tags Tags to label the trace for easier filtering in the Opik platform.
Request Options Settings for request batching, SSL certificate validation, proxy usage, and timeout configuration.

Output

JSON

  • id - Unique identifier of the created trace.
  • name - Name or label of the trace.
  • input - Input data associated with the trace.
  • metadata - Metadata associated with the trace.
  • tags - Tags assigned to the trace for filtering.
  • threadId - Thread ID used to group related traces.
  • status - Status of the trace, e.g., active or completed.

Dependencies

  • Opik API with an API key credential

Troubleshooting

  • Ensure the project ID or name is valid and accessible with the provided API credentials.
  • Verify that the input and metadata assignments are correctly formatted as key-value pairs.
  • Check network connectivity and proxy settings if requests fail or time out.
  • If SSL certificate validation fails, consider enabling the option to ignore SSL issues, but be aware of security risks.

Links

Discussion