API Reference
The AGNT5 API is organized around REST. It accepts JSON request bodies, returns JSON-encoded responses, and uses standard HTTP response codes and verbs.
Base URL
Every endpoint on this page includes its full path, relative to this host.
https://api.agnt5.comAuthentication
Every request needs a personal API key or a bearer token. See Authentication for the full picture, including rate limits and the error envelope.
X-API-KEY: your_api_keyResources
Add an item
Add a single item to a dataset's draft by hand.
Apply deduplication
Remove duplicate draft items identified by a preview.
Compare versions
Compare two published versions and see what items were added, removed, or changed.
Create a dataset
Create a dataset.
Get a dataset
Fetch a single dataset by its UUID.
Get an item
Fetch a single draft item, including its input/output payload and revision history.
Import from a run
Add an item to the draft from a completed workflow run, capturing its actual input and output.
Import from CSV
Bulk-import items from a CSV file, mapping columns to input/expected-output fields.
List datasets
List a project's datasets.
List draft items
List the items currently in a dataset's draft.
List versions
List a dataset's published versions.
Preview deduplication
Preview which draft items would be removed by deduplication, without changing anything.
Publish a version
Publish the current draft as a new immutable version.
Restore the draft from a version
Reset the mutable draft back to the contents of a published version.
Deployment components
List the functions, workflows, and agents registered by a deployment's workers.
Deployment logs
Read application logs emitted by a deployment's workers.
Deployment runs
List workflow runs executed on a deployment.
Deployment workers
List the worker processes currently executing a deployment's workflows.
Get a deployment
Fetch a single deployment by its UUID.
List deployments
List deployments the authenticated user can access.
Create an environment
Create a custom environment beyond the four defaults, for example a per-feature preview environment.
Get an environment
Fetch a single environment by its UUID.
List environments
List a project's environments.
Cancel a run
Cancel an in-progress run.
Cancel an experiment
Cancel an experiment and every run currently in progress under it.
Create an experiment
Create an experiment against a dataset.
Get a run
Fetch a single run by its UUID.
Get a run item
Fetch a single item's actual output, expected output, and per-scorer results.
Get an experiment
Fetch a single experiment by its UUID.
Get run results
Fetch a run's aggregate results once it completes.
Get score evidence
Fetch the full evidence (prompt, model reasoning, or code output) behind a single score.
Journal links
Fetch links back to the durable execution journal entries behind a run's items, for step-by-step debugging.
List experiments
List a project's experiments.
List runs
List the runs triggered for an experiment.
List scores
List individual scorer results across runs, for building custom dashboards.
Run CI gate
Fetch the pass/fail gate result for a run, for use in CI pipelines.
Run failures
List the dataset items a run scored below threshold on.
Run scorers
List the scorers applied to a run and their aggregate results.
Run summary
Fetch a run's pass/fail counts, average scores, and duration.
Trigger a run
Trigger a new run of an experiment against its current dataset version.
Get a project
Fetch a single project by its UUID.
List projects
List the projects visible to the authenticated user, across every workspace they belong to.
Create a quality case
Open a quality case, optionally linked to the run or score that surfaced it.
Get a quality case
Fetch a single quality case by its UUID.
List quality cases
List a project's quality cases.
Get a run
Fetch a single run summary by its run ID.
Get a trace
Fetch every span recorded for a single trace.
List runs
List run summaries: status, timing, retries, and LLM cost for each run.
List traces
List distributed traces recorded for a workspace, optionally scoped to a single deployment.
Run logs
Read structured logs emitted during a run, across every worker and step.
Get a scorer
Fetch a single scorer by its UUID.
List scorers
List a project's scorers.
Create a secret
Create a secret. The plaintext value is encrypted at rest and never returned by any endpoint — only its masked form.
Delete a secret
Delete a secret. Deployments that reference it lose access to the value on their next restart.
Get a secret
Fetch a single secret's metadata by its UUID.
List secrets
List secrets visible to the authenticated user. Values are always masked; use the reveal endpoint to read a decrypted value.
Update a secret
Update a secret's name, type, or value.
Get a worker
Fetch a single worker by its UUID.
List workers
List workers. Scope the query with either project_id or deployment_id.
Authentication
Authenticate requests to the AGNT5 API with a personal API key or a bearer token, and understand the error envelope and rate limits every endpoint shares.
Projects
List the projects your credential can access and fetch a single project's metadata, workflow count, and production deployment.
Environments
List, fetch, and create the environments a project deploys into: local, preview, staging, and production.
Secrets
Store, list, and rotate the credentials your deployed workflows read at runtime, scoped to a project and environment.
Deployments
List and inspect deployments, and read their logs, workers, components, and runs.
Workers
List and inspect the worker processes that execute your deployed workflows, agents, and functions.
Runs & Traces
List workflow runs, read a run's logs, and fetch the distributed trace recorded for each run.
Datasets
Create eval datasets, publish immutable versions, import examples from runs or CSV, and deduplicate items.
Experiments
Create experiments, trigger runs against a dataset, and read run results, failures, and scores.
Scorers
List and fetch the scorers a project uses to grade experiment results.
Quality Cases
List, fetch, and open quality cases: tracked behavior regressions linked back to the runs, scores, and datasets that surfaced them.
HTTP Status Codes
AGNT5 uses conventional HTTP response codes to indicate success or failure.