# Avido ## Docs - [Changelog](https://docs.avidoai.com/changelog.md): Track product releases and improvements across Avido versions. - [Welcome to Avido Docs 🚀](https://docs.avidoai.com/introduction.md): The AI Quality Assurance platform built for fintechs and financial services enterprises. - [SDK Reference](https://docs.avidoai.com/sdk.md): Complete reference for the Avido Node.js and Python SDKs. - [Webhooks](https://docs.avidoai.com/webhooks.md): Trigger automated Avido tests from outside your code and validate payloads securely. - [Tracing](https://docs.avidoai.com/traces.md): Capture every step of your LLM workflow and send it to Avido for replay, evaluation, and monitoring. - [OpenTelemetry Integration](https://docs.avidoai.com/opentelemetry.md): Send traces to Avido using standard OpenTelemetry tooling and OpenInference instrumentation. - [QuickStart](https://docs.avidoai.com/quickstart.md): The fastest way to set up evaluations for your AI application - [Inbox](https://docs.avidoai.com/inbox.md): Central hub for triaging and managing all AI application issues and regressions - [System Journal](https://docs.avidoai.com/system-journal.md): Automated monitoring and documentation of AI model changes for compliance and operational excellence - [Documents](https://docs.avidoai.com/documents.md): Knowledge management system for creating, versioning, and optimizing RAG-ready content - [Evaluations](https://docs.avidoai.com/evaluations.md): Built-in and custom evaluation types to measure AI quality, safety, and performance. - [Metrics](https://docs.avidoai.com/metrics.md): Four numbers that tell you whether to trust your AI's quality — and what to do when you can't. - [Experiments](https://docs.avidoai.com/experiments.md): Compare different AI configurations to find what works best for your use case - [Validate an incoming webhook request](https://docs.avidoai.com/api-reference/webhook/validate-an-incoming-webhook-request.md): Checks the body (including timestamp and signature) against the configured webhook secret. Returns `{ valid: true }` if the signature is valid. - [Get webhook configuration for an application](https://docs.avidoai.com/api-reference/webhook/get-webhook-configuration-for-an-application.md): Retrieves the webhook configuration for the current application. Returns null if no webhook is configured. - [Create or update webhook configuration for an application](https://docs.avidoai.com/api-reference/webhook/create-or-update-webhook-configuration-for-an-application.md): Creates a webhook for the current application if one does not exist, otherwise updates the existing webhook URL and/or headers. - [Delete webhook configuration for an application](https://docs.avidoai.com/api-reference/webhook/delete-webhook-configuration-for-an-application.md): Deletes the webhook configuration for the current application. - [Test webhook configuration for an application](https://docs.avidoai.com/api-reference/webhook/test-webhook-configuration-for-an-application.md): Sends a test webhook request to the configured webhook URL with a sample payload. Returns success status and any error details. - [Stream assistant response](https://docs.avidoai.com/api-reference/assistant/stream-assistant-response.md): Streams assistant output and tool execution events as an SSE UI message stream. - [List enabled auth providers](https://docs.avidoai.com/api-reference/authentication/list-enabled-auth-providers.md): Returns which auth providers are currently configured on the API server: the set of SSO social providers (derived from `GOOGLE_CLIENT_ID/SECRET`, `MICROSOFT_CLIENT_ID/SECRET`) and whether an email provider (Loops) is configured via `LOOPS_API_KEY`. This endpoint is unauthenticated so that the login… - [Get current session](https://docs.avidoai.com/api-reference/authentication/get-current-session.md): Returns the currently authenticated session for cookie-based callers. Used by the apps/app frontend to centralise session validation through the API rather than calling Better Auth directly. Authenticated by Better Auth session cookie on the parent domain — NOT by API key / application id like the r… - [List organizations for current session](https://docs.avidoai.com/api-reference/authentication/list-organizations-for-current-session.md): Returns the organisations the authenticated user belongs to. Called in-process via `auth.api.listOrganizations` so server-to-server requests are not subject to Better Auth's `Origin`-header CSRF check. Cookie-authenticated: NOT part of the public API key / application-id contract. - [Set active organization for current session](https://docs.avidoai.com/api-reference/authentication/set-active-organization-for-current-session.md): Switches the active organisation on the authenticated session. Called in-process via `auth.api.setActiveOrganization` so server-to-server requests are not subject to Better Auth's `Origin`-header CSRF check. Better Auth rotates the active-org cookie; the rotated `Set-Cookie` headers are forwarded on… - [Get a public preview of an organization invitation](https://docs.avidoai.com/api-reference/authentication/get-a-public-preview-of-an-organization-invitation.md): Returns the organization name, invitee email, and invitation lifecycle metadata for the given invitation id. Unauthenticated so the invite landing page can render context before the user signs up. The *inviter* identity is intentionally not exposed; the invitee email is returned so the sign-up form… - [Get install setup status](https://docs.avidoai.com/api-reference/setup/get-install-setup-status.md): Returns whether the install needs onboarding. An install needs onboarding when no organizations exist in the database; the dashboard uses this to show a sign-up-first bootstrap flow on fresh deployments. This endpoint is unauthenticated so the login UI can call it before the user has a session. - [Get app config](https://docs.avidoai.com/api-reference/app-config/get-app-config.md): Returns public feature flags the dashboard needs to render correctly (e.g., whether the web scraper is enabled). - [List applications](https://docs.avidoai.com/api-reference/applications/list-applications.md): Retrieves a paginated list of applications with optional filtering. - [Create a new application](https://docs.avidoai.com/api-reference/applications/create-a-new-application.md): Creates a new application configuration. - [Get a single application by ID](https://docs.avidoai.com/api-reference/applications/get-a-single-application-by-id.md): Retrieves detailed information about a specific application. - [Update an existing application](https://docs.avidoai.com/api-reference/applications/update-an-existing-application.md): Updates an existing application's configuration. - [Get a single application by slug](https://docs.avidoai.com/api-reference/applications/get-a-single-application-by-slug.md): Retrieves detailed information about a specific application by its slug. - [Get application chatbot config](https://docs.avidoai.com/api-reference/application-chatbot-config/get-application-chatbot-config.md): Retrieves the chatbot playground configuration for an application. Returns defaults if no config row has been saved yet. - [Update application chatbot config](https://docs.avidoai.com/api-reference/application-chatbot-config/update-application-chatbot-config.md): Updates the chatbot playground configuration for an application. Creates a config row if one does not exist. - [Stream application chatbot playground response](https://docs.avidoai.com/api-reference/application-chatbot-config/stream-application-chatbot-playground-response.md): Streams a chatbot playground response for a chatbot application with PostHog chatbot playground rollout enabled, using the application's configured prompt and active knowledge base. - [List API keys for an application](https://docs.avidoai.com/api-reference/api-keys/list-api-keys-for-an-application.md): Retrieves all API keys associated with the current application. - [Create an API key for an application](https://docs.avidoai.com/api-reference/api-keys/create-an-api-key-for-an-application.md): Creates a new API key for the current application. The plaintext key is returned only once and must be stored securely. - [Delete an API key](https://docs.avidoai.com/api-reference/api-keys/delete-an-api-key.md): Deletes an API key for the current application. Idempotent — returns 204 whether or not the key existed. - [Send product feedback](https://docs.avidoai.com/api-reference/feedback/send-product-feedback.md): Dispatches a feedback email to the Avido team via the Loops transactional email integration. The authenticated user's email is attached automatically. - [List Traces](https://docs.avidoai.com/api-reference/traces/list-traces.md): Retrieve traces with associated steps, filtered by application ID and optional date parameters. - [Get a single trace by ID](https://docs.avidoai.com/api-reference/traces/get-a-single-trace-by-id.md): Retrieves detailed information about a specific trace. - [Get a single trace by Test ID](https://docs.avidoai.com/api-reference/traces/get-a-single-trace-by-test-id.md): Retrieves detailed information about a specific trace. - [List Trace Sessions](https://docs.avidoai.com/api-reference/traces/list-trace-sessions.md): Retrieve traces grouped by referenceId with aggregated metrics. - [Ingest events](https://docs.avidoai.com/api-reference/ingestion/ingest-events.md): Ingest an array of events (traces or steps) to store and process. - [Ingest OTLP traces](https://docs.avidoai.com/api-reference/ingestion/ingest-otlp-traces.md): Ingest OpenTelemetry Protocol (OTLP) traces in JSON format. Converts OTLP spans to Avido events and processes them through the standard ingestion pipeline. Supports OpenInference semantic conventions for LLM, tool, retriever, and other span types. - [List tasks](https://docs.avidoai.com/api-reference/tasks/list-tasks.md): Retrieves a paginated list of tasks with optional filtering. - [Create a new task](https://docs.avidoai.com/api-reference/tasks/create-a-new-task.md): Creates a new task. - [Bulk update tasks](https://docs.avidoai.com/api-reference/tasks/bulk-update-tasks.md): Updates multiple tasks at once. When isVerified is set, recalculates parent topic verification. - [Bulk delete tasks](https://docs.avidoai.com/api-reference/tasks/bulk-delete-tasks.md): Deletes multiple tasks by their IDs. - [Bulk archive tasks](https://docs.avidoai.com/api-reference/tasks/bulk-archive-tasks.md): Archives multiple tasks by their IDs. Archived tasks are hidden from operational surfaces but preserved for reporting. - [Get task IDs](https://docs.avidoai.com/api-reference/tasks/get-task-ids.md): Retrieves a list of task IDs with optional filtering. - [Get a single task by ID](https://docs.avidoai.com/api-reference/tasks/get-a-single-task-by-id.md): Retrieves detailed information about a specific task. - [Update an existing task](https://docs.avidoai.com/api-reference/tasks/update-an-existing-task.md): Updates an existing task with the provided information. - [Delete a task](https://docs.avidoai.com/api-reference/tasks/delete-a-task.md): Deletes a single task by ID. - [Get task coverage statistics](https://docs.avidoai.com/api-reference/tasks/get-task-coverage-statistics.md): Returns the percentage of active tasks that have at least one test run within the specified date range. - [Run a task](https://docs.avidoai.com/api-reference/tasks/run-a-task.md): Triggers the execution of a task. - [List installed task templates](https://docs.avidoai.com/api-reference/tasks/list-installed-task-templates.md): Returns the titles of task templates that have already been installed for this application. - [Install a task template](https://docs.avidoai.com/api-reference/tasks/install-a-task-template.md): Installs a predefined task template, creating tasks, topics, and eval definitions. - [Upload tasks via CSV file](https://docs.avidoai.com/api-reference/tasks/upload-tasks-via-csv-file.md): Uploads a CSV file containing tasks. The file will be validated and processed asynchronously. - [Add tags to multiple tasks](https://docs.avidoai.com/api-reference/tasks/add-tags-to-multiple-tasks.md): Add one or more tags to multiple tasks in a single request. All tasks and tags must exist and belong to the same organization. - [Create or update a task schedule](https://docs.avidoai.com/api-reference/task-schedules/create-or-update-a-task-schedule.md) - [Get task schedule](https://docs.avidoai.com/api-reference/task-schedules/get-task-schedule.md) - [Delete task schedule](https://docs.avidoai.com/api-reference/task-schedules/delete-task-schedule.md) - [Link an evaluation definition to a task](https://docs.avidoai.com/api-reference/eval-definitions/link-an-evaluation-definition-to-a-task.md): Associates an evaluation definition with a task for automatic evaluation. - [Unlink an evaluation definition from a task](https://docs.avidoai.com/api-reference/eval-definitions/unlink-an-evaluation-definition-from-a-task.md): Removes the association between an evaluation definition and a task. - [Update task-specific config for an evaluation definition](https://docs.avidoai.com/api-reference/eval-definitions/update-task-specific-config-for-an-evaluation-definition.md): Updates the task-specific configuration (e.g., expected output) for an evaluation definition on a specific task. - [Link evaluation definitions to topics](https://docs.avidoai.com/api-reference/eval-definitions/link-evaluation-definitions-to-topics.md): Associates evaluation definitions with topics for automatic evaluation of all tasks in those topics. - [Unlink evaluation definitions from topics](https://docs.avidoai.com/api-reference/eval-definitions/unlink-evaluation-definitions-from-topics.md): Removes the association between evaluation definitions and topics. - [Link evaluation definitions to the application](https://docs.avidoai.com/api-reference/eval-definitions/link-evaluation-definitions-to-the-application.md): Associates evaluation definitions with the application for automatic evaluation of all tasks. - [Unlink evaluation definitions from the application](https://docs.avidoai.com/api-reference/eval-definitions/unlink-evaluation-definitions-from-the-application.md): Removes the association between evaluation definitions and the application. - [Get application-level evaluation definitions](https://docs.avidoai.com/api-reference/eval-definitions/get-application-level-evaluation-definitions.md): Retrieves all evaluation definitions linked at the application level. - [List evaluation definitions](https://docs.avidoai.com/api-reference/eval-definitions/list-evaluation-definitions.md): Retrieves a paginated list of evaluation definitions for an application. - [Create an evaluation definition](https://docs.avidoai.com/api-reference/eval-definitions/create-an-evaluation-definition.md): Creates a new evaluation definition for an application. - [Update an evaluation definition](https://docs.avidoai.com/api-reference/eval-definitions/update-an-evaluation-definition.md): Updates an existing evaluation definition. - [Delete an evaluation definition](https://docs.avidoai.com/api-reference/eval-definitions/delete-an-evaluation-definition.md): Deletes an evaluation definition and all associated data (cascade delete of linked tasks and evaluations). - [List experiments](https://docs.avidoai.com/api-reference/experiments/list-experiments.md): Retrieves a paginated list of experiments with optional filtering. - [Create an experiment](https://docs.avidoai.com/api-reference/experiments/create-an-experiment.md): Creates a new experiment with the provided details. - [Get an experiment](https://docs.avidoai.com/api-reference/experiments/get-an-experiment.md): Retrieves a single experiment by ID. - [Update an experiment](https://docs.avidoai.com/api-reference/experiments/update-an-experiment.md): Updates an existing experiment with the provided details. - [List experiment variants](https://docs.avidoai.com/api-reference/experiments/list-experiment-variants.md): Retrieves a paginated list of variants for the specified experiment. - [Create an experiment variant](https://docs.avidoai.com/api-reference/experiments/create-an-experiment-variant.md): Creates a new variant for the specified experiment. - [Update experiment variant](https://docs.avidoai.com/api-reference/experiments/update-experiment-variant.md): Updates a specific experiment variant. Only title, description, and configPatch can be updated. - [Trigger experiment variant](https://docs.avidoai.com/api-reference/experiments/trigger-experiment-variant.md): Triggers execution of all tasks associated with the experiment for the specified variant. Returns 204 No Content on success. - [List facts](https://docs.avidoai.com/api-reference/facts/list-facts.md): Retrieves a paginated list of facts with optional filtering. - [Bulk create facts](https://docs.avidoai.com/api-reference/facts/bulk-create-facts.md): Creates multiple facts in a single request. - [Verify or unverify facts](https://docs.avidoai.com/api-reference/facts/verify-or-unverify-facts.md): Sets the isVerified flag on one or more facts in a single bulk operation. - [Get a single fact by ID](https://docs.avidoai.com/api-reference/facts/get-a-single-fact-by-id.md): Retrieves detailed information about a specific fact. - [Update a fact's statement](https://docs.avidoai.com/api-reference/facts/update-a-facts-statement.md): Edits a fact's statement text. Clears isVerified. - [Delete a fact](https://docs.avidoai.com/api-reference/facts/delete-a-fact.md): Permanently deletes a single fact by ID. - [List inference steps](https://docs.avidoai.com/api-reference/inference-steps/list-inference-steps.md) - [Create an inference step](https://docs.avidoai.com/api-reference/inference-steps/create-an-inference-step.md) - [List tests](https://docs.avidoai.com/api-reference/evals/list-tests.md): Retrieves a paginated list of tests with optional filtering. - [Get a single test by ID](https://docs.avidoai.com/api-reference/tests/get-a-single-test-by-id.md): Retrieves detailed information about a specific test. - [List topics](https://docs.avidoai.com/api-reference/topics/list-topics.md): Retrieves a paginated list of topics with optional filtering. - [Create a new topic](https://docs.avidoai.com/api-reference/topics/create-a-new-topic.md): Creates a new topic. - [Bulk update topics](https://docs.avidoai.com/api-reference/topics/bulk-update-topics.md): Updates multiple topics at once. When isTasksVerified is set, cascades to all tasks in the topics. - [Bulk archive topics](https://docs.avidoai.com/api-reference/topics/bulk-archive-topics.md): Archives multiple topics by their IDs. When cascade is true (default), also archives all tasks associated with the topics. - [Get topic IDs](https://docs.avidoai.com/api-reference/topics/get-topic-ids.md): Retrieves a list of topic IDs with optional filtering. - [Get a single topic by ID](https://docs.avidoai.com/api-reference/topics/get-a-single-topic-by-id.md): Retrieves detailed information about a specific topic. - [Update a topic](https://docs.avidoai.com/api-reference/topics/update-a-topic.md): Updates a topic, including assigning or unassigning a user. - [Delete a topic](https://docs.avidoai.com/api-reference/topics/delete-a-topic.md): Deletes a topic. By default, tasks associated with the topic will have their topicId set to null. Use cascade=true to explicitly delete all associated tasks. - [Archive a topic](https://docs.avidoai.com/api-reference/topics/archive-a-topic.md): Archives a topic. When cascade is true, also archives all tasks associated with this topic. Archived topics are hidden from operational surfaces but preserved for reporting. - [List annotations](https://docs.avidoai.com/api-reference/annotations/list-annotations.md): Retrieves a paginated list of annotations with optional filtering. - [Create a new annotation](https://docs.avidoai.com/api-reference/annotations/create-a-new-annotation.md): Creates a new annotation. - [Get a single annotation by ID](https://docs.avidoai.com/api-reference/annotations/get-a-single-annotation-by-id.md): Retrieves detailed information about a specific annotation. - [Update an annotation](https://docs.avidoai.com/api-reference/annotations/update-an-annotation.md): Updates an existing annotation. - [Delete an annotation](https://docs.avidoai.com/api-reference/annotations/delete-an-annotation.md): Deletes an existing annotation. - [List issues](https://docs.avidoai.com/api-reference/issues/list-issues.md): Retrieves a paginated list of issues with optional filtering by date range, status, priority, assignee, and more. - [Create a new issue](https://docs.avidoai.com/api-reference/issues/create-a-new-issue.md): Creates a new issue for tracking problems or improvements. - [Bulk update issues](https://docs.avidoai.com/api-reference/issues/bulk-update-issues.md): Updates status, priority, or assignment for multiple issues. Returns updated issues with assigned user information. User must be a valid organization member and not banned when assigning. - [List minimal issues](https://docs.avidoai.com/api-reference/issues/list-minimal-issues.md): Retrieves a paginated list of issues with only essential fields (id, title, status, source, priority, createdAt, assignedTo). Optimized for list views and performance. Supports sorting by createdAt and priority. - [Get a single issue by ID with duplicates](https://docs.avidoai.com/api-reference/issues/get-a-single-issue-by-id-with-duplicates.md): Retrieves detailed information about a specific issue, including all duplicate/child issues in the duplicates array with minimal fields (id, title, createdAt). - [Update an issue](https://docs.avidoai.com/api-reference/issues/update-an-issue.md): Updates an existing issue. Can be used to reassign, change status, update priority, or modify any other issue fields. - [Delete an issue](https://docs.avidoai.com/api-reference/issues/delete-an-issue.md): Deletes an existing issue permanently. - [Get suggested task for an issue](https://docs.avidoai.com/api-reference/issues/get-suggested-task-for-an-issue.md): Retrieves the DRAFT task associated with an issue of type SUGGESTED_TASK. This endpoint only works for issues that have a taskId and are of type SUGGESTED_TASK with a task in DRAFT status. - [Update and activate suggested task](https://docs.avidoai.com/api-reference/issues/update-and-activate-suggested-task.md): Updates the DRAFT task associated with an issue and activates it (changes status from DRAFT to ACTIVE). This endpoint only works for issues of type SUGGESTED_TASK with a task in DRAFT status. After activation, the task becomes a regular active task. - [List assignments for a quickstart](https://docs.avidoai.com/api-reference/assignments/list-assignments-for-a-quickstart.md): Retrieves a paginated list of assignments for a quickstart with optional filtering. - [Create a new assignment](https://docs.avidoai.com/api-reference/assignments/create-a-new-assignment.md): Creates a new assignment linking a user to a topic. - [Bulk reassign assignments](https://docs.avidoai.com/api-reference/assignments/bulk-reassign-assignments.md): Reassigns multiple assignments to a single user in one request. - [Bulk create assignments](https://docs.avidoai.com/api-reference/assignments/bulk-create-assignments.md): Creates multiple assignments in a single request. - [Get a single assignment by ID](https://docs.avidoai.com/api-reference/assignments/get-a-single-assignment-by-id.md): Retrieves detailed information about a specific assignment. - [Update an assignment](https://docs.avidoai.com/api-reference/assignments/update-an-assignment.md): Updates an existing assignment. - [Delete an assignment](https://docs.avidoai.com/api-reference/assignments/delete-an-assignment.md): Deletes an assignment. - [List contradictions for a quickstart](https://docs.avidoai.com/api-reference/contradictions/list-contradictions-for-a-quickstart.md): Retrieves a paginated list of contradictions for the given quickstart with optional filtering. - [Update a contradiction](https://docs.avidoai.com/api-reference/contradictions/update-a-contradiction.md): Updates an existing contradiction (e.g. assign a user or mark as resolved). - [Delete a contradiction](https://docs.avidoai.com/api-reference/contradictions/delete-a-contradiction.md): Deletes a contradiction. - [Accept all unresolved contradictions](https://docs.avidoai.com/api-reference/contradictions/accept-all-unresolved-contradictions.md): Marks every unresolved contradiction in this quickstart as resolved in a single operation. - [List runs](https://docs.avidoai.com/api-reference/runs/list-runs.md): Retrieves a paginated list of runs with optional filtering. - [Get a single run by ID](https://docs.avidoai.com/api-reference/runs/get-a-single-run-by-id.md): Retrieves detailed information about a specific run. - [List style guides](https://docs.avidoai.com/api-reference/style-guides/list-style-guides.md): Retrieves a paginated list of style guides with optional filtering. - [Create a new style guide](https://docs.avidoai.com/api-reference/style-guides/create-a-new-style-guide.md): Creates a new style guide. - [Get a single style guide by ID](https://docs.avidoai.com/api-reference/style-guides/get-a-single-style-guide-by-id.md): Retrieves detailed information about a specific style guide. - [Update a style guide](https://docs.avidoai.com/api-reference/style-guides/update-a-style-guide.md): Updates the content of an existing style guide. - [List documents](https://docs.avidoai.com/api-reference/documents/list-documents.md): Retrieves a paginated list of documents with optional filtering by status, assignee, parent, and other criteria. Only returns documents with active approved versions unless otherwise specified. - [Create a new document](https://docs.avidoai.com/api-reference/documents/create-a-new-document.md): Creates a new document with the provided information. - [Get document counts](https://docs.avidoai.com/api-reference/documents/get-document-counts.md): Returns total document count and count of documents that have an active version. - [Get document counts by assignee](https://docs.avidoai.com/api-reference/documents/get-document-counts-by-assignee.md): Retrieves document counts grouped by assignee for the authenticated organization. - [Delete multiple documents](https://docs.avidoai.com/api-reference/documents/delete-multiple-documents.md): Deletes multiple documents by ID. This will also delete their versions. - [Bulk export documents as CSV](https://docs.avidoai.com/api-reference/documents/bulk-export-documents-as-csv.md): Exports selected documents as a CSV file with title and content columns from active versions - [Get all document IDs](https://docs.avidoai.com/api-reference/documents/get-all-document-ids.md): Fetches all document IDs without pagination. Supports filtering by status and tags. Useful for bulk operations. - [Bulk optimize multiple documents](https://docs.avidoai.com/api-reference/documents/bulk-optimize-multiple-documents.md): Triggers background optimization jobs for multiple documents. Returns information about which documents were successfully queued and which failed. - [Bulk update status of multiple document versions](https://docs.avidoai.com/api-reference/documents/bulk-update-status-of-multiple-document-versions.md): Updates the status of the active version for multiple documents. - [Bulk activate latest versions of multiple documents](https://docs.avidoai.com/api-reference/documents/bulk-activate-latest-versions-of-multiple-documents.md): Activates the latest version (highest version number) for multiple documents. Returns information about which documents were successfully activated and which failed. - [Get a single document by ID](https://docs.avidoai.com/api-reference/documents/get-a-single-document-by-id.md): Retrieves detailed information about a specific document, including its parent-child relationships and active version details. - [Update a document's topic](https://docs.avidoai.com/api-reference/documents/update-a-documents-topic.md): Updates the topic assignment for a specific document. Set topicId to null to remove the topic. - [Delete a document](https://docs.avidoai.com/api-reference/documents/delete-a-document.md): Deletes a document and its related document versions by the given document ID - [Assign a document to a user](https://docs.avidoai.com/api-reference/documents/assign-a-document-to-a-user.md): Assigns a specific document to a user by their user ID. - [Remove assignee from a document](https://docs.avidoai.com/api-reference/documents/remove-assignee-from-a-document.md): Removes the assignee from a specific document. - [Optimize a document](https://docs.avidoai.com/api-reference/documents/optimize-a-document.md): Triggers a background optimization job for the specified document. Returns 204 No Content on success. - [Update a document version](https://docs.avidoai.com/api-reference/documents/update-a-document-version.md): Updates the content, title, status, or other fields of a specific document version. - [Upload documents via CSV, PDF, or XLSX file](https://docs.avidoai.com/api-reference/documents/upload-documents-via-csv-pdf-or-xlsx-file.md): Uploads a CSV, PDF, or XLSX file containing documents. CSV files will be validated and processed. PDF files will be processed via OCR. XLSX files are split per sheet and each sheet is converted into one or more documents via an LLM. Unless processFile is set to false, processing happens asynchronous… - [Upload a batch of markdown documents](https://docs.avidoai.com/api-reference/documents/upload-a-batch-of-markdown-documents.md): Uploads a batch of pre-parsed markdown documents from a folder upload. Documents are processed asynchronously via a background job. - [Add tags to multiple documents](https://docs.avidoai.com/api-reference/documents/add-tags-to-multiple-documents.md): Add one or more tags to multiple documents in a single request. All documents and tags must exist and belong to the same organization. - [List all versions of a document](https://docs.avidoai.com/api-reference/document-versions/list-all-versions-of-a-document.md): Retrieves all versions of a specific document, ordered by version number descending. - [Create a new version of a document](https://docs.avidoai.com/api-reference/document-versions/create-a-new-version-of-a-document.md): Creates a new version of an existing document. The new version will have the next version number. - [Get a specific version of a document](https://docs.avidoai.com/api-reference/document-versions/get-a-specific-version-of-a-document.md): Retrieves a specific version of a document by version number. - [Activate a specific version of a document](https://docs.avidoai.com/api-reference/document-versions/activate-a-specific-version-of-a-document.md): Makes a specific version the active version of a document. This is the version that will be returned by default when fetching the document. - [List document tests](https://docs.avidoai.com/api-reference/document-tests/list-document-tests.md): Retrieves a paginated list of document tests with optional filtering by type and status - [Trigger document test](https://docs.avidoai.com/api-reference/document-tests/trigger-document-test.md): Creates and triggers a document test execution. For KNOWLEDGE_COVERAGE and DOCS_TO_TASKS_MAPPING, applicationId is required. - [Get document test detail](https://docs.avidoai.com/api-reference/document-tests/get-document-test-detail.md): Retrieves a single document test by id, including the fully-hydrated `results` payload (for MECE rows this loads per-document detail from the relational tables on demand). The list endpoint omits this payload to keep polling cheap. - [List tags](https://docs.avidoai.com/api-reference/tags/list-tags.md): Retrieves a paginated list of tags with optional search filtering. - [Create a new tag](https://docs.avidoai.com/api-reference/tags/create-a-new-tag.md): Creates a new tag with the provided information. - [Get a single tag by ID](https://docs.avidoai.com/api-reference/tags/get-a-single-tag-by-id.md): Retrieves detailed information about a specific tag. - [Update an existing tag](https://docs.avidoai.com/api-reference/tags/update-an-existing-tag.md): Updates an existing tag with the provided information. - [Delete a tag](https://docs.avidoai.com/api-reference/tags/delete-a-tag.md): Deletes a tag by ID. This will also remove the tag from all documents. - [Archive a tag](https://docs.avidoai.com/api-reference/tags/archive-a-tag.md): Archives a tag. Archived tags are hidden from operational surfaces but preserved for reporting. Archiving a tag removes it from the active unique constraint, allowing a new tag with the same name. - [Get tags for a document](https://docs.avidoai.com/api-reference/document-tags/get-tags-for-a-document.md): Retrieves all tags assigned to a specific document. - [Update document tags](https://docs.avidoai.com/api-reference/document-tags/update-document-tags.md): Updates the tags assigned to a specific document. This replaces all existing tags. - [Get tags for a task](https://docs.avidoai.com/api-reference/task-tags/get-tags-for-a-task.md): Retrieves all tags assigned to a specific task. - [Update task tags](https://docs.avidoai.com/api-reference/task-tags/update-task-tags.md): Updates the tags assigned to a specific task. This replaces all existing tags. - [List all scrape jobs](https://docs.avidoai.com/api-reference/scrape-jobs/list-all-scrape-jobs.md) - [Create a scrape job](https://docs.avidoai.com/api-reference/scrape-jobs/create-a-scrape-job.md) - [Create a bulk scrape job](https://docs.avidoai.com/api-reference/scrape-jobs/create-a-bulk-scrape-job.md): Create one scrape job covering an array of URLs (up to 2000 per request). All accepted URLs land as pages of a single job; URLs rejected by validation or deduplication are reported in the response. - [Get a scrape job by ID](https://docs.avidoai.com/api-reference/scrape-jobs/get-a-scrape-job-by-id.md) - [Update a scrape job](https://docs.avidoai.com/api-reference/scrape-jobs/update-a-scrape-job.md) - [Delete a scrape job](https://docs.avidoai.com/api-reference/scrape-jobs/delete-a-scrape-job.md) - [Start scraping all pages of a scrape job](https://docs.avidoai.com/api-reference/scrape-jobs/start-scraping-all-pages-of-a-scrape-job.md) - [List quickstarts](https://docs.avidoai.com/api-reference/quickstartsv2/list-quickstarts.md): Retrieves a paginated list of quickstarts with optional filtering. - [Create a quickstart](https://docs.avidoai.com/api-reference/quickstartsv2/create-a-quickstart.md): Creates a new quickstart with the provided details. - [Get a quickstart](https://docs.avidoai.com/api-reference/quickstartsv2/get-a-quickstart.md): Retrieves a single quickstart by ID. - [Update a quickstart](https://docs.avidoai.com/api-reference/quickstartsv2/update-a-quickstart.md): Updates an existing quickstart with the provided details. - [Delete a quickstart](https://docs.avidoai.com/api-reference/quickstartsv2/delete-a-quickstart.md): Deletes a quickstart by ID. For incomplete quickstarts, also deletes all draft entities created during the pipeline. Returns 422 if the quickstart is currently being processed. - [List topics for a quickstart](https://docs.avidoai.com/api-reference/quickstartsv2/list-topics-for-a-quickstart.md): Retrieves a paginated list of topics belonging to a specific quickstart. - [List tasks for a quickstart topic](https://docs.avidoai.com/api-reference/quickstartsv2/list-tasks-for-a-quickstart-topic.md): Retrieves a paginated list of tasks belonging to a specific topic within a quickstart. - [List topics for a quickstart with document statistics](https://docs.avidoai.com/api-reference/quickstartsv2/list-topics-for-a-quickstart-with-document-statistics.md): Retrieves a paginated list of topics belonging to a specific quickstart, enriched with document count and coverage statistics. - [List documents for a quickstart topic](https://docs.avidoai.com/api-reference/quickstartsv2/list-documents-for-a-quickstart-topic.md): Retrieves a paginated list of documents belonging to a specific topic within a quickstart. - [List generated articles for a quickstart topic](https://docs.avidoai.com/api-reference/quickstartsv2/list-generated-articles-for-a-quickstart-topic.md): Retrieves generated KB articles for a specific topic, showing per-task generation status. - [Get KB material counts for a quickstart](https://docs.avidoai.com/api-reference/quickstartsv2/get-kb-material-counts-for-a-quickstart.md): Returns the number of knowledge base documents and scrape jobs associated with a quickstart. - [Get policy eval counts for a quickstart](https://docs.avidoai.com/api-reference/quickstartsv2/get-policy-eval-counts-for-a-quickstart.md): Returns the total topics count, application-wide eval count, and per-topic eval counts for a quickstart. Includes both DRAFT and ACTIVE evals. Only evals created by this quickstart are counted. - [List conversations](https://docs.avidoai.com/api-reference/conversations/list-conversations.md): Retrieves a paginated list of conversations with optional filtering. When includeMessages=true is passed with a taskId, each conversation includes its messages. - [Get a conversation](https://docs.avidoai.com/api-reference/conversations/get-a-conversation.md): Retrieves a single conversation by ID, including its messages. - [Translate a conversation](https://docs.avidoai.com/api-reference/conversations/translate-a-conversation.md): Translates every message in the given conversation into English using an LLM. The response is not persisted; clients call this each time they need a translation. - [Upload conversations via CSV file](https://docs.avidoai.com/api-reference/conversations/upload-conversations-via-csv-file.md): Uploads a CSV file containing conversations. The file will be validated and, unless processFile is false, processed asynchronously. Conversations are application-scoped and require an application context. - [List file processings](https://docs.avidoai.com/api-reference/fileprocessings/list-file-processings.md): Retrieves a paginated list of file processings with optional filtering. - [Delete a file processing](https://docs.avidoai.com/api-reference/file-processings/delete-a-file-processing.md): Deletes a file processing record by the given ID - [List reports](https://docs.avidoai.com/api-reference/reports/list-reports.md): Retrieves a paginated list of reports with optional filtering by date range, assignee, and application. - [Create a new report](https://docs.avidoai.com/api-reference/reports/create-a-new-report.md): Creates a new report. - [Get a single report](https://docs.avidoai.com/api-reference/reports/get-a-single-report.md): Retrieves a specific report by its ID. - [Update a report](https://docs.avidoai.com/api-reference/reports/update-a-report.md): Updates an existing report. Can be used to update title, description, or reassign/unassign the report. - [Delete a report](https://docs.avidoai.com/api-reference/reports/delete-a-report.md): Deletes a specific report by its ID. - [Get eval stats aggregated by date](https://docs.avidoai.com/api-reference/reports/get-eval-stats-aggregated-by-date.md): Aggregates eval pass/total/avg-score counts bucketed by the requested time granularity. - [Get eval stats aggregated by date and eval definition](https://docs.avidoai.com/api-reference/reports/get-eval-stats-aggregated-by-date-and-eval-definition.md): Aggregates eval pass/total/avg-score counts bucketed by time granularity and eval definition. - [Get eval stats aggregated by date and topic](https://docs.avidoai.com/api-reference/reports/get-eval-stats-aggregated-by-date-and-topic.md): Aggregates eval pass/total/avg-score counts bucketed by time granularity and topic. - [Get eval stats aggregated by eval definition](https://docs.avidoai.com/api-reference/reports/get-eval-stats-aggregated-by-eval-definition.md): Aggregates eval pass/total counts per eval definition across the time range. EXPERIMENT runs are excluded. - [Query reporting data](https://docs.avidoai.com/api-reference/reports/query-reporting-data.md): Queries reporting data from specified datasources with optional filters and groupBy clauses. Supports aggregation and date truncation for time-based grouping. - [List available datasources](https://docs.avidoai.com/api-reference/reports/list-available-datasources.md): Returns a list of all available reporting datasources with their IDs and human-readable names. - [Get columns for a datasource](https://docs.avidoai.com/api-reference/reports/get-columns-for-a-datasource.md): Returns metadata about the whitelisted columns for a specific datasource that can be used for filtering in reporting queries. - [Get context-aware columns for a datasource](https://docs.avidoai.com/api-reference/reports/get-context-aware-columns-for-a-datasource.md): Returns available columns for a datasource based on the intent and current query context. For filters/groupBy/measurements intents, returns all eligible columns. For orderBy intent, returns columns based on current groupBy and measurements context. - [Get distinct values for a column](https://docs.avidoai.com/api-reference/reports/get-distinct-values-for-a-column.md): Returns a list of distinct values from a specific column in a datasource. For relation columns (e.g., topicId), returns the related records with their IDs and display names. - [Get human annotation stats aggregated by date](https://docs.avidoai.com/api-reference/reports/get-human-annotation-stats-aggregated-by-date.md): Aggregates human annotation pass/total counts bucketed by the requested time granularity. `avgScore` is always 0 and is returned only for chart-shape parity with eval stats. - [List model pricing](https://docs.avidoai.com/api-reference/model-pricing/list-model-pricing.md): Retrieves a paginated list of model pricing entries with optional filtering - [Create model pricing](https://docs.avidoai.com/api-reference/model-pricing/create-model-pricing.md): Creates a new model pricing entry - [Get model pricing](https://docs.avidoai.com/api-reference/model-pricing/get-model-pricing.md): Retrieves a specific model pricing entry by ID - [Update model pricing](https://docs.avidoai.com/api-reference/model-pricing/update-model-pricing.md): Updates an existing model pricing entry - [Delete model pricing](https://docs.avidoai.com/api-reference/model-pricing/delete-model-pricing.md): Deletes a model pricing entry - [Get organization config](https://docs.avidoai.com/api-reference/organization-config/get-organization-config.md): Retrieves the organization configuration settings. Returns default values if no config has been saved yet. - [Update organization config](https://docs.avidoai.com/api-reference/organization-config/update-organization-config.md): Updates the organization configuration settings. Creates a new config if one doesn't exist. Only updates fields that are provided in the request body. - [List organization members](https://docs.avidoai.com/api-reference/organization-members/list-organization-members.md): Retrieves the list of users who belong to the authenticated organization. Banned members are filtered out of the response. The `email` field is only returned to callers with `owner` or `admin` role — lower-privileged members receive the same payload without `email` to prevent directory enumeration. - [List human annotations](https://docs.avidoai.com/api-reference/human-annotations/list-human-annotations.md): Retrieves a paginated list of human annotations with optional filtering by trace, annotator, source, and verdict - [Create a human annotation](https://docs.avidoai.com/api-reference/human-annotations/create-a-human-annotation.md): Creates a new human annotation judgement for a trace. When verdict is false, automatically creates an Inbox issue - [Update a human annotation](https://docs.avidoai.com/api-reference/human-annotations/update-a-human-annotation.md): Updates an existing human annotation. Both verdict and critique can be modified. When verdict is changed to false, critique must meet the minimum length requirement - [List human annotation queues](https://docs.avidoai.com/api-reference/human-annotations/list-human-annotation-queues.md): Retrieves a paginated list of human annotation queues with pending/completed counts. Supports filtering by topic and assignee - [List human annotation queue items](https://docs.avidoai.com/api-reference/human-annotations/list-human-annotation-queue-items.md): Retrieves a paginated list of queue items (traces enqueued for annotation). Supports filtering by queue, completion status, and trace - [Get quality metrics for the At a Glance page](https://docs.avidoai.com/api-reference/reporting/get-quality-metrics-for-the-at-a-glance-page.md): Returns aggregated quality metrics across all active tasks, including confidence and stability distributions. ## OpenAPI Specs - [openapi.documented](https://app.stainless.com/api/spec/documented/avido/openapi.documented.yml) - [openapi](https://docs.avidoai.com/openapi.json) - [package](https://docs.avidoai.com/package.json) ## Optional - [Support](mailto:support@avidoai.com) - [LLM-friendly docs](https://docs.avidoai.com/llms-full.txt)