DEVELOPER GUIDE / PRE-RELEASE

Design your evidence workflow.

Practical preparation for an UpTrain pilot. No package install or API key required.

There is no public ingestion API, SDK, or MCP endpoint for UpTrain yet. This guide describes the proposed interface model, not runnable integration instructions.

Start with a representative execution

Choose a non-sensitive workflow containing a tool call, an error or retry, and a human decision if your application uses one. Document the runtime and version, how it starts a run, and which lifecycle hooks it exposes.

Use the execution explorer’s sample JSON to discuss desired fields. Its format is illustrative and is not a supported API contract.

Define the envelope

A useful proposed event envelope includes execution identity, event identity, actor, event type, recorded timestamp, outcome, and capture-source metadata. Parent identifiers help preserve handoffs and causality.

  • Keep timestamps and measured durations distinct.
  • Represent unknown values explicitly.
  • Use a stable idempotency key when retrying an upload.
  • Separate failed execution from failed artifact verification.

Credentials and ingestion

Before a pilot, agree workspace scoping, revocation, rate limits, request size limits, retry behavior, and secret storage. Do not put model-provider keys into a request to this website.

The contact endpoint serves inquiries only. It is not an execution-ingestion endpoint and must not receive artifacts or telemetry.

Read interfaces and machine actions

The intended product scope includes machine-readable evidence access and scoped assistant integrations. Read access should not implicitly grant certification, deletion, credential issuance, or spending authority.

A future REST specification or MCP tool list will describe the actual implemented permissions. We do not publish invented endpoints or commands while that contract remains unsettled.

Prepare your pilot request

Tell us your runtime, approximate workload, required fields, sensitive data exclusions, expected retention, and the review process. Share descriptions rather than raw traces. Scope and any required data-processing agreement must be settled before production data is connected.

Discuss this with the UpTrain team →

LET’S START WITH YOUR WORKFLOW

Make your next agent run easier to understand.

Discuss early access

Tell us what your agents do and what you need to understand. No payment or runtime connection required.