Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Create Agent Definition — API"
title: "Create Agent Definition"
description: "Create a new agent definition and its initial version. Accepts agent type, name, provider, API key, and system prompt. Returns the created agent object."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Delete Agent Definitions — API"
title: "Delete Agent Definitions"
description: "Bulk soft-delete one or more agent definitions and all associated versions. Accepts a list of agent UUIDs and returns a count of agents updated."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Fetch Assistant from Provider — API"
title: "Fetch Assistant from Provider"
description: "Fetch an assistant's name and system prompt from an external voice provider such as Vapi. Requires assistant ID, API key, and provider name."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Get Agent Definition — API"
title: "Get Agent Definition"
description: "Retrieve a specific agent definition by UUID, including its full version history, provider details, and configuration snapshot."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "List Agent Definitions — API"
title: "List Agent Definitions"
description: "Return a paginated list of agent definitions. Filter by agent type, search by name or assistant ID, and pin a specific agent to the top of results."
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/agent-versions/createagentversion.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Create Agent Version — API"
title: "Create Agent Version"
description: "Create a new version of an agent definition. Accepts agent name, language, system prompt, commit message, and provider config. Returns the new version object."
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/agent-versions/getagentversion.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Get Agent Version — API"
title: "Get Agent Version"
description: "Retrieve a specific agent version by agent UUID and version UUID, including its full configuration snapshot, prompt, and provider settings."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Get Version Call Executions — API"
title: "Get Version Call Executions"
description: "Retrieve paginated call executions and their evaluation results for a specific agent version. Supports limit and page query parameters."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Get Version Eval Summary — API"
title: "Get Version Eval Summary"
description: "Retrieve aggregated evaluation summary statistics for an agent version, including pass rate, fail count, and error count per eval metric."
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/agent-versions/listagentversions.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "List Agent Versions — API"
title: "List Agent Versions"
description: "Retrieve a paginated list of all versions for a given agent definition. Supports limit and page parameters. Returns version metadata and commit history."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Bulk Annotate Spans — API"
title: "Bulk Annotate Spans"
description: "Submit label scores and notes for multiple observation spans in one request. Accepts an array of span IDs with their annotation values and score sources."
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/annotations/items/add-items.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Add Items to Annotation Queue — API"
title: "Add Items to Annotation Queue"
description: "Add one or more source items (traces, spans) to an annotation queue in bulk. Accepts queue UUID and an array of source type and source ID pairs."
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/annotations/items/assign-items.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Assign Queue Items to Annotator — API"
title: "Assign Queue Items to Annotator"
description: "Assign one or more annotation queue items to specific annotators. Accepts queue UUID, a list of item UUIDs, and a list of user UUIDs to assign."
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/annotations/items/bulk-remove-items.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Bulk Remove Queue Items — API"
title: "Bulk Remove Queue Items"
description: "Remove multiple items from an annotation queue in a single request. Accepts the queue UUID and an array of item UUIDs to delete from the queue."
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/annotations/items/complete-item.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Complete Annotation Queue Item — API"
title: "Complete Annotation Queue Item"
description: "Mark an annotation queue item as completed. Returns the completed item ID and, optionally, the next pending item available for annotation."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Get Annotation Item Detail — API"
title: "Get Annotation Item Detail"
description: "Retrieve a queue item with full source content, queue metadata, labels, existing annotations, and navigation pointers for the annotation interface."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Get Queue Item Annotations — API"
title: "Get Queue Item Annotations"
description: "Retrieve all annotation scores submitted for a specific queue item, including label values, score source, annotator ID, and timestamps."
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/annotations/items/get-next-item.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Get Next Annotation Queue Item — API"
title: "Get Next Annotation Queue Item"
description: "Retrieve the next available queue item for the current user to annotate. Returns item ID, source type, status, and assignment info."
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/annotations/items/list-items.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "List Annotation Queue Items — API"
title: "List Annotation Queue Items"
description: "List items in an annotation queue with pagination. Filter by status, source type, or assigned user. Returns item details and annotation progress."
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/annotations/items/release-item.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Release Annotation Queue Item — API"
title: "Release Annotation Queue Item"
description: "Release a reserved annotation queue item so it becomes available for reassignment to another annotator. Returns a boolean release confirmation."
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/annotations/items/skip-item.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Skip Annotation Queue Item — API"
title: "Skip Annotation Queue Item"
description: "Mark an annotation queue item as skipped by the current user. Returns the skipped item ID and the next available pending item for annotation."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Submit Item Annotations — API"
title: "Submit Item Annotations"
description: "Submit label scores and reviewer notes for an annotation queue item. Accepts queue UUID, item UUID, an array of annotation values, and optional notes."
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/annotations/labels/create-label.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Create Annotation Label — API"
title: "Create Annotation Label"
description: "Create a new annotation label with a name, type (star, binary, categorical), description, settings, and optional notes. Returns the created label object."
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/annotations/labels/delete-label.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Delete Annotation Label — API"
title: "Delete Annotation Label"
description: "Soft-delete an annotation label by UUID. Deleted labels are hidden but recoverable via the restore endpoint. Returns HTTP 204 on success."
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/annotations/labels/get-label.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Get Annotation Label — API"
title: "Get Annotation Label"
description: "Retrieve a specific annotation label by UUID, including its type, settings, description, project scope, and allow-notes configuration."
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/annotations/labels/list-labels.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "List Annotation Labels — API"
title: "List Annotation Labels"
description: "List annotation labels with optional filters for type, name search, project, dataset scope, and usage count. Returns a paginated array of label objects."
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/annotations/labels/restore-label.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Restore Annotation Label — API"
title: "Restore Annotation Label"
description: "Restore a previously soft-deleted annotation label by UUID. Returns the full restored label object with its original type, settings, and configuration."
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/annotations/labels/update-label.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Update Annotation Label — API"
title: "Update Annotation Label"
description: "Update an existing annotation label's name, description, type, or settings by UUID. Returns the updated label object with all current field values."
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/annotations/queues/add-label.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Add Label to Annotation Queue — API"
title: "Add Label to Annotation Queue"
description: "Attach an existing annotation label to a queue by queue UUID and label UUID. Returns the updated queue-label association with ordering and required flag."
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/annotations/queues/create-queue.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Create Annotation Queue — API"
title: "Create Annotation Queue"
description: "Create an annotation queue with name, assignment strategy, annotator list, labels, and review settings. Returns the fully configured queue object."
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/annotations/queues/delete-queue.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Delete Annotation Queue — API"
title: "Delete Annotation Queue"
description: "Soft-delete an annotation queue by UUID. The queue and its items are hidden but not permanently removed. Returns a deleted boolean confirmation."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Export Queue to Dataset — API"
title: "Export Queue to Dataset"
description: "Export completed annotation queue items into a Future AGI dataset. Accepts queue UUID, target dataset ID, and optional status filter for selective export."
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/annotations/queues/export.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Export Annotation Queue — API"
title: "Export Annotation Queue"
description: "Export annotation queue items and their scores as JSON or CSV. Filter by item status. Returns source type, annotations, annotator names, and timestamps."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Find Queues for Source — API"
title: "Find Queues for Source"
description: "Find all annotation queues containing a specific source item. Accepts source type, source UUID, or a JSON array of sources for multi-source lookup."
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/annotations/queues/get-agreement.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Get Inter-Annotator Agreement — API"
title: "Get Inter-Annotator Agreement"
description: "Retrieve inter-annotator agreement scores for a queue, including overall agreement percentage and per-label breakdown for quality assurance analysis."
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/annotations/queues/get-analytics.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Get Annotation Queue Analytics — API"
title: "Get Annotation Queue Analytics"
description: "Retrieve detailed analytics for a queue including daily throughput, annotator performance, label score distribution, and item status breakdown."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Get or Create Default Queue — API"
title: "Get or Create Default Queue"
description: "Get the default annotation queue for a project, dataset, or agent definition, automatically creating one if it does not yet exist. Returns queue and labels."
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/annotations/queues/get-progress.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Get Annotation Queue Progress — API"
title: "Get Annotation Queue Progress"
description: "Retrieve progress statistics for an annotation queue, including total, pending, in-progress, completed, and skipped counts with per-annotator breakdowns."
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/annotations/queues/get-queue.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Get Annotation Queue — API"
title: "Get Annotation Queue"
description: "Retrieve full details of an annotation queue by UUID, including assignment strategy, labels, annotators, review settings, and creation metadata."
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/annotations/queues/list-queues.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "List Annotation Queues — API"
title: "List Annotation Queues"
description: "List annotation queues with optional filters for status and name search. Supports pagination and optionally includes item counts per queue."
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/annotations/queues/remove-label.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Remove Label from Queue — API"
title: "Remove Label from Queue"
description: "Detach an annotation label from a queue by queue UUID and label UUID. Removing a label hides it from future annotation sessions for that queue."
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/annotations/queues/update-queue.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Update Annotation Queue — API"
title: "Update Annotation Queue"
description: "Update an annotation queue's name, description, instructions, assignment strategy, or review settings by UUID. Returns the updated queue configuration."
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/annotations/queues/update-status.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Update Annotation Queue Status — API"
title: "Update Annotation Queue Status"
description: "Transition an annotation queue to a new status (draft, active, paused, or completed). Accepts queue UUID and target status. Returns the updated queue object."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Bulk Create Annotation Scores — API"
title: "Bulk Create Annotation Scores"
description: "Create multiple annotation scores on a single source in one request. Accepts source type, source UUID, and an array of label ID, value, and score source."
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/annotations/scores/create-score.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Create Annotation Score — API"
title: "Create Annotation Score"
description: "Create a single annotation score on a trace, span, or session. Accepts source type, source UUID, label UUID, score value, and score source type."
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/annotations/scores/delete-score.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Delete Annotation Score — API"
title: "Delete Annotation Score"
description: "Soft-delete an annotation score by UUID. Only the score creator or an org admin can delete. Returns HTTP 204 on success."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Get Scores for Source — API"
title: "Get Scores for Source"
description: "Retrieve all annotation scores for a specific source (trace, span, generation, or session). Filter by label UUID or annotator UUID to narrow results."
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/annotations/scores/list-scores.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "List Annotation Scores — API"
title: "List Annotation Scores"
description: "List annotation scores with optional filters for source type, source UUID, label, and annotator. Supports pagination via page and page_size parameters."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Check Eval Config Exists — API"
title: "Check Eval Config Exists"
description: "Check if a custom eval config with the same name and field mapping already exists in a project before creating a duplicate."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Create Custom Eval Config — API"
title: "Create Custom Eval Config"
description: "Create a new custom eval config for a project by specifying an eval template, name, field mapping, and optional config settings."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Delete Custom Eval Config — API"
title: "Delete Custom Eval Config"
description: "Soft-delete a custom eval config by UUID. Returns 204 No Content on success. The config is deactivated and no longer applied."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Get Custom Eval Config — API"
title: "Get Custom Eval Config"
description: "Retrieve a specific custom eval config by UUID, returning its template, name, project, field mapping, and current configuration."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "List Custom Eval Configs — API"
title: "List Custom Eval Configs"
description: "List all custom eval configs, with optional filtering by project UUID or eval task UUID to narrow results."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Update Custom Eval Config — API"
title: "Update Custom Eval Config"
description: "Partially update an existing custom eval config by UUID. Supports patching name, mapping, config, or template fields individually."
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/dataset-evals/add-dataset-eval.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Add Dataset Eval — API"
title: "Add Dataset Eval"
description: "Add an evaluation to a dataset by selecting a template and configuring the input/output key mapping. Returns the created eval record."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Create Custom Eval Template — API"
title: "Create Custom Eval Template"
description: "Create a reusable custom eval template with criteria, output type (e.g. Pass/Fail), required keys, and model configuration."
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/dataset-evals/delete-dataset-eval.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Delete Dataset Eval — API"
title: "Delete Dataset Eval"
description: "Remove an evaluation from a dataset by eval ID. Optionally delete the associated eval column and its data from the dataset."
---

Expand Down
Loading
Loading