API Reference
View the Promptic API schema. Download OpenAPI spec.
Workspace
Get current workspace GET
Retrieve details for the authenticated workspace.
List workspaces GET
List all workspaces for the current user.
Components
List all components GET
Retrieve all AI components in your workspace.
Create a component POST
Create a new AI component to organize prompts and traces.
Get a component GET
Retrieve details for a specific component.
Experiments
Create an experiment POST
Set up a new prompt optimization experiment.
Start an experiment POST
Start a pending experiment to begin optimization.
Duplicate an experiment POST
Clone an experiment with its observations and evaluators; optionally seed from the source's best optimized prompt.
Get best iteration GET
Retrieve the highest-scoring iteration.
Evaluators & Observations
Create evaluator(s) POST
Add evaluation criteria to score prompt performance.
Create observation(s) POST
Add expected outputs and input variables for training and evaluation.
Deployment
Deploy experiment POST
Deploy an optimized experiment to a component.
Get deployed prompt GET
Retrieve the currently deployed prompt, model, and score.
Traces
List traces GET
Query traces with filtering by status, component, and time range.
Ingest OTLP traces POST
Send OpenTelemetry trace data in JSON or protobuf format.
Get tracing stats GET
Get aggregated tracing statistics for your workspace.
Storage
Create a presigned upload POST
Reserve a storage object and get a short-lived direct-upload descriptor.
Get a download URL GET
Return a short-lived signed GET URL for a storage object.
Artifacts
List artifacts for a trace GET
List the artifacts referenced by a trace's spans.
Upload an artifact POST
Register an artifact from a storage object or inline base64 content.
Get artifact metadata GET
Retrieve metadata and a content URL for an artifact.
Download artifact content GET
Redirect to a short-lived provider URL for the artifact bytes.