PAGES

← Promptfoo

Promptfoo — API

Promptfoo APIv1.0.0 Read the vendor's spec ↗

  • 444 endpoints
  • 1 version archived since Nov 6, 2026
  • Last checked Nov 6, 2026

Promptfoo API provides programmatic access to promptfoo's evaluation and testing platform for large language models.

Get started

first call
$ curl "https://api.promptfoo.app/health"
Base URL
https://api.promptfoo.app
Authenticate
Bearer token in the Authorization header Promptfoo API token (sk-), service-account token (sk-service-), or legacy JWT in the Authorization: Bearer {token} header.
1 other scheme
  • API key in the promptfoo.sid cookie

What it covers

  • Compatibility 84 Redirect-only compatibility endpoints that move older unversioned API callers onto canonical /api/v1 paths without changing request semantics for non-GET methods.
  • Admin 54 Global-admin operations for users, organizations, licensing, on-prem deployments, server settings, and code-scan administration.
  • Results 30 Access and manage evaluation results, including test outputs, metrics, and performance data from completed evaluations.
  • Guardrails 26 AI safety guardrails for prompt analysis and adaptive prompting.
  • Red Team 26 Configure and execute red team security testing including adversarial attacks, jailbreak attempts, and vulnerability assessments.
  • Organizations 22 Manage organizations, users, and service accounts.
  • Teams 19 Create and manage teams within organizations.
  • Providers 16 Configure and manage AI model providers (OpenAI, Anthropic, etc.) including API keys, endpoints, and provider-specific settings.
  • Red Team Grading Guidelines 13 Manage grading guideline documents used to steer red team evaluation and review workflows.
  • Issues 11 Track and manage issues identified during evaluations, including vulnerability findings and quality problems.
  • Users 11 User authentication, profile management, and team membership operations.
  • Code Scan 10 GitHub App code-scan setup, feedback collection, and webhook processing endpoints.
32 more areas
  • Intake 9 Customer intake links, public questionnaire submission, and admin conversion workflow.
  • Eval Configs 8 Create and manage reusable evaluation configurations used to run promptfoo evaluations.
  • Grading Guidance 8 Manage guidance documents that agentic grading and regrading can consult for domain-specific rubrics.
  • Webhooks 7 Set up and manage webhooks to receive real-time notifications about events in your organization.
  • Dashboard 6 Dashboard metrics for scan history, target vulnerability status, and issue trends.
  • Grading Examples 6 Manage grading examples used to train and calibrate the evaluation system for consistent scoring.
  • Jobs 5 Create, monitor, and manage evaluation jobs.
  • Model Audits 5 Persist, retrieve, and deduplicate model audit scans and model security findings.
  • Result Tags 5 Manage organization-scoped result tags used to classify and retrieve evaluation results.
  • Roles 5 Define and manage role-based access control (RBAC) for fine-grained permission management within your organization.
  • Setup 5 On-prem setup wizard endpoints for installation and first-run configuration.
  • Tags 5 Manage shared tag metadata used across evaluation resources.
  • Tasks 5 Server-side generation and utility task endpoints used by eval and red team workflows.
  • Cli Targets 4 Manage CLI-discovered targets that are associated with teams and used by red team scans.
  • Guardrails Dashboard 4 Guardrail analytics endpoints for request history, policy effectiveness, and target-level trends.
  • Server Settings 4 On-prem server settings for provider configuration and setup state.
  • Api Tokens 3 Create, inspect, and revoke API tokens used for authenticated automation and service integrations.
  • Auth 3 Session-oriented authentication helpers for FusionAuth login, identity-provider discovery, and logout.
  • Guidance Review Jobs 3 Create and monitor background jobs that review evaluations against grading guidance.
  • Reevaluation Jobs 3 Background jobs for re-evaluating existing evaluation results and polling grading progress.
  • Remediation Reports 3 Generate and retrieve remediation reports and hardened prompts for evaluation findings.
  • System 3 System health and status endpoints for monitoring the API service availability and version information.
  • Blobs 2 Upload and retrieve binary artifacts referenced by eval results, with public eval download support and authenticated private access.
  • Guardrail Jobs 2 Background jobs for generating guardrail policies from red team scan results.
  • Reports 2 Generate and retrieve aggregate reports for evaluations and red team findings.
  • Audit Logs 1 Access comprehensive audit logs for compliance, security monitoring, and tracking all actions within your organization.
  • Config 1 Runtime configuration and service-health metadata used by the app and deployment operators.
  • Datasets 1 Upload and manage datasets used by evaluation workflows.
  • License 1 License status and usage information for cloud and on-prem deployments.
  • Permissions 1 Permission preflight checks for running configs with team-scoped providers and targets.
  • Prompts 1 Retrieve reusable prompts available to evaluation workflows.
  • Traces 1 Trace retrieval endpoints for evaluation-level observability and debugging.

Endpoints

444 of 444

Open an endpoint for a runnable command, its inputs and what it returns.

Compatibility 84

  • DELETE /api Redirect DELETE /api compatibility request

    Loading…

  • DELETE /api/eval Redirect legacy DELETE /api/eval upload request

    Loading…

  • DELETE /api/eval/{legacyPath} Redirect legacy DELETE /api/eval upload request

    Loading…

  • DELETE /api/{apiPath} Redirect DELETE /api compatibility request

    Loading…

  • DELETE /redteam/configs Redirect legacy DELETE /redteam/configs API request

    Loading…

  • DELETE /redteam/configs/{legacyPath} Redirect legacy DELETE /redteam/configs API request

    Loading…

  • DELETE /results Redirect legacy DELETE /results API request

    Loading…

  • DELETE /results/{legacyPath} Redirect legacy DELETE /results API request

    Loading…

  • DELETE /task Redirect legacy DELETE /task API request

    Loading…

  • DELETE /task/{legacyPath} Redirect legacy DELETE /task API request

    Loading…

  • DELETE /users Redirect legacy DELETE /users API request

    Loading…

  • DELETE /users/{legacyPath} Redirect legacy DELETE /users API request

    Loading…

  • GET /api Redirect GET /api compatibility request

    Loading…

  • GET /api/eval Redirect legacy GET /api/eval upload request

    Loading…

  • GET /api/eval/{legacyPath} Redirect legacy GET /api/eval upload request

    Loading…

  • GET /api/{apiPath} Redirect GET /api compatibility request

    Loading…

  • GET /redteam/configs Redirect legacy GET /redteam/configs API request

    Loading…

  • GET /redteam/configs/{legacyPath} Redirect legacy GET /redteam/configs API request

    Loading…

  • GET /results Redirect legacy GET /results API request

    Loading…

  • GET /results/{legacyPath} Redirect legacy GET /results API request

    Loading…

  • GET /task Redirect legacy GET /task API request

    Loading…

  • GET /task/{legacyPath} Redirect legacy GET /task API request

    Loading…

  • GET /users Redirect legacy GET /users API request

    Loading…

  • GET /users/{legacyPath} Redirect legacy GET /users API request

    Loading…

  • HEAD /api Redirect HEAD /api compatibility request

    Loading…

  • HEAD /api/eval Redirect legacy HEAD /api/eval upload request

    Loading…

  • HEAD /api/eval/{legacyPath} Redirect legacy HEAD /api/eval upload request

    Loading…

  • HEAD /api/{apiPath} Redirect HEAD /api compatibility request

    Loading…

  • HEAD /redteam/configs Redirect legacy HEAD /redteam/configs API request

    Loading…

  • HEAD /redteam/configs/{legacyPath} Redirect legacy HEAD /redteam/configs API request

    Loading…

  • HEAD /results Redirect legacy HEAD /results API request

    Loading…

  • HEAD /results/{legacyPath} Redirect legacy HEAD /results API request

    Loading…

  • HEAD /task Redirect legacy HEAD /task API request

    Loading…

  • HEAD /task/{legacyPath} Redirect legacy HEAD /task API request

    Loading…

  • HEAD /users Redirect legacy HEAD /users API request

    Loading…

  • HEAD /users/{legacyPath} Redirect legacy HEAD /users API request

    Loading…

  • PATCH /api Redirect PATCH /api compatibility request

    Loading…

  • PATCH /api/eval Redirect legacy PATCH /api/eval upload request

    Loading…

  • PATCH /api/eval/{legacyPath} Redirect legacy PATCH /api/eval upload request

    Loading…

  • PATCH /api/{apiPath} Redirect PATCH /api compatibility request

    Loading…

  • PATCH /redteam/configs Redirect legacy PATCH /redteam/configs API request

    Loading…

  • PATCH /redteam/configs/{legacyPath} Redirect legacy PATCH /redteam/configs API request

    Loading…

  • PATCH /results Redirect legacy PATCH /results API request

    Loading…

  • PATCH /results/{legacyPath} Redirect legacy PATCH /results API request

    Loading…

  • PATCH /task Redirect legacy PATCH /task API request

    Loading…

  • PATCH /task/{legacyPath} Redirect legacy PATCH /task API request

    Loading…

  • PATCH /users Redirect legacy PATCH /users API request

    Loading…

  • PATCH /users/{legacyPath} Redirect legacy PATCH /users API request

    Loading…

  • POST /api Redirect POST /api compatibility request

    Loading…

  • POST /api/eval Redirect legacy POST /api/eval upload request

    Loading…

  • POST /api/eval/{legacyPath} Redirect legacy POST /api/eval upload request

    Loading…

  • POST /api/{apiPath} Redirect POST /api compatibility request

    Loading…

  • POST /redteam/configs Redirect legacy POST /redteam/configs API request

    Loading…

  • POST /redteam/configs/{legacyPath} Redirect legacy POST /redteam/configs API request

    Loading…

  • POST /results Redirect legacy POST /results API request

    Loading…

  • POST /results/{legacyPath} Redirect legacy POST /results API request

    Loading…

  • POST /task Redirect legacy POST /task API request

    Loading…

  • POST /task/{legacyPath} Redirect legacy POST /task API request

    Loading…

  • POST /users Redirect legacy POST /users API request

    Loading…

  • POST /users/{legacyPath} Redirect legacy POST /users API request

    Loading…

  • PUT /api Redirect PUT /api compatibility request

    Loading…

  • PUT /api/eval Redirect legacy PUT /api/eval upload request

    Loading…

  • PUT /api/eval/{legacyPath} Redirect legacy PUT /api/eval upload request

    Loading…

  • PUT /api/{apiPath} Redirect PUT /api compatibility request

    Loading…

  • PUT /redteam/configs Redirect legacy PUT /redteam/configs API request

    Loading…

  • PUT /redteam/configs/{legacyPath} Redirect legacy PUT /redteam/configs API request

    Loading…

  • PUT /results Redirect legacy PUT /results API request

    Loading…

  • PUT /results/{legacyPath} Redirect legacy PUT /results API request

    Loading…

  • PUT /task Redirect legacy PUT /task API request

    Loading…

  • PUT /task/{legacyPath} Redirect legacy PUT /task API request

    Loading…

  • PUT /users Redirect legacy PUT /users API request

    Loading…

  • PUT /users/{legacyPath} Redirect legacy PUT /users API request

    Loading…

  • TRACE /api Redirect TRACE /api compatibility request

    Loading…

  • TRACE /api/eval Redirect legacy TRACE /api/eval upload request

    Loading…

  • TRACE /api/eval/{legacyPath} Redirect legacy TRACE /api/eval upload request

    Loading…

  • TRACE /api/{apiPath} Redirect TRACE /api compatibility request

    Loading…

  • TRACE /redteam/configs Redirect legacy TRACE /redteam/configs API request

    Loading…

  • TRACE /redteam/configs/{legacyPath} Redirect legacy TRACE /redteam/configs API request

    Loading…

  • TRACE /results Redirect legacy TRACE /results API request

    Loading…

  • TRACE /results/{legacyPath} Redirect legacy TRACE /results API request

    Loading…

  • TRACE /task Redirect legacy TRACE /task API request

    Loading…

  • TRACE /task/{legacyPath} Redirect legacy TRACE /task API request

    Loading…

  • TRACE /users Redirect legacy TRACE /users API request

    Loading…

  • TRACE /users/{legacyPath} Redirect legacy TRACE /users API request

    Loading…

Admin 54

  • DELETE /api/v1/admin/licenses/{id} Delete an organization license

    Loading…

  • DELETE /api/v1/admin/onprem-licenses/{id} Delete an on-prem license

    Loading…

  • DELETE /api/v1/admin/onprem-licenses/{id}/gcp-access Revoke GCP access for an on-prem license

    Loading…

  • DELETE /api/v1/admin/organizations/{id} Delete an organization

    Loading…

  • DELETE /api/v1/admin/organizations/{id}/users/{userId} Remove a user from an organization

    Loading…

  • DELETE /api/v1/admin/users/{userId} Delete a Promptfoo user record

    Loading…

  • DELETE /api/v1/admin/users/{userId}/organizations/{organizationId} Remove a user from an organization

    Loading…

  • GET /api/v1/admin/check Check global admin access

    Loading…

  • GET /api/v1/admin/code-scan-installations List code scan GitHub App installations

    Loading…

  • GET /api/v1/admin/code-scan-installations/stats Get code scan installation statistics

    Loading…

  • GET /api/v1/admin/code-scan-installations/{id} Get a code scan GitHub App installation

    Loading…

  • GET /api/v1/admin/code-scans List code scans

    Loading…

  • GET /api/v1/admin/code-scans/stats Get code scan statistics

    Loading…

  • GET /api/v1/admin/code-scans/{id} Get a code scan with comments and feedback

    Loading…

  • GET /api/v1/admin/licenses/{id} Get an organization license

    Loading…

  • GET /api/v1/admin/onprem-licenses List on-prem licenses

    Loading…

  • GET /api/v1/admin/onprem-licenses/stats Get on-prem license statistics

    Loading…

  • GET /api/v1/admin/onprem-licenses/{id} Get an on-prem license

    Loading…

  • GET /api/v1/admin/onprem-licenses/{id}/deployment-bundle Download deployment bundle for an on-prem license

    Loading…

  • GET /api/v1/admin/onprem-licenses/{id}/deployment-keys List deployment keys for an on-prem license

    Loading…

  • GET /api/v1/admin/organizations List organizations for global admin

    Loading…

  • GET /api/v1/admin/organizations/{id} Get one organization for global admin

    Loading…

  • GET /api/v1/admin/organizations/{id}/guardrails-config Get organization guardrails configuration

    Loading…

  • GET /api/v1/admin/organizations/{id}/users List organization users

    Loading…

  • GET /api/v1/admin/organizations/{organizationId}/licenses List organization licenses

    Loading…

  • GET /api/v1/admin/organizations/{organizationId}/probe-usage Get probe usage history for an organization

    Loading…

  • GET /api/v1/admin/organizations/{organizationId}/roles List organization roles

    Loading…

  • GET /api/v1/admin/organizations/{organizationId}/targets List organization targets

    Loading…

  • GET /api/v1/admin/organizations/{organizationId}/teams List organization teams with probe usage

    Loading…

  • GET /api/v1/admin/server-settings List cloud server settings

    Loading…

  • GET /api/v1/admin/server-settings/{key} Get a cloud server setting

    Loading…

  • GET /api/v1/admin/users List users for global admin

    Loading…

  • GET /api/v1/admin/users/{userId} Get user detail for global admin

    Loading…

  • GET /api/v1/admin/users/{userId}/teams List teams for a user

    Loading…

  • PATCH /api/v1/admin/licenses/{id} Update an organization license

    Loading…

  • PATCH /api/v1/admin/onprem-licenses/{id} Update an on-prem license

    Loading…

  • PATCH /api/v1/admin/organizations/{id} Update an organization

    Loading…

  • PATCH /api/v1/admin/teams/{teamId} Update team probe cap

    Loading…

  • PATCH /api/v1/admin/users/{userId}/organizations/{organizationId} Toggle a user admin role in an organization

    Loading…

  • POST /api/v1/admin/licenses Create an organization license

    Loading…

  • POST /api/v1/admin/onprem-licenses Create an on-prem license

    Loading…

  • POST /api/v1/admin/onprem-licenses/{id}/deployment-key Generate deployment key for an on-prem license

    Loading…

  • POST /api/v1/admin/onprem-licenses/{id}/provision-gcp Provision GCP access for an on-prem license

    Loading…

  • POST /api/v1/admin/onprem-licenses/{id}/regenerate Regenerate an on-prem license

    Loading…

  • POST /api/v1/admin/onprem-licenses/{id}/revoke Revoke an on-prem license

    Loading…

  • POST /api/v1/admin/onprem-licenses/{id}/rotate-gcp-key Rotate the GCP service account key for an on-prem license

    Loading…

  • POST /api/v1/admin/organizations Create an organization

    Loading…

  • POST /api/v1/admin/organizations/{id}/users Add or create a user in an organization

    Loading…

  • POST /api/v1/admin/organizations/{id}/users/bulk Bulk add users to an organization

    Loading…

  • POST /api/v1/admin/users/{userId}/organizations Add a user to an organization

    Loading…

  • POST /api/v1/admin/users/{userId}/resend-invite Resend an invitation email

    Loading…

  • POST /api/v1/admin/users/{userId}/send-password-reset-email Send a password reset email

    Loading…

  • PUT /api/v1/admin/organizations/{id}/guardrails-config Update organization guardrails configuration

    Loading…

  • PUT /api/v1/admin/server-settings/{key} Update a cloud server setting

    Loading…

Results 30

  • DELETE /api/v1/results Bulk delete evaluations

    Loading…

  • DELETE /api/v1/results/{id} Delete evaluation

    Loading…

  • DELETE /api/v1/results/{id}/share Revoke evaluation share links

    Loading…

  • GET /api/v1/results List evaluations

    Loading…

  • GET /api/v1/results/evalResults/{id}/issue Get the issue associated with an eval result

    Loading…

  • GET /api/v1/results/failed-tests Get failed test cases for retry

    Loading…

  • GET /api/v1/results/report-export Export the selected team’s red team reports

    Loading…

  • GET /api/v1/results/{id} Get evaluation

    Loading…

  • GET /api/v1/results/{id}/failed-test-cases Get all failed test cases for rerun

    Loading…

  • GET /api/v1/results/{id}/metadata-keys Get metadata keys

    Loading…

  • GET /api/v1/results/{id}/metadata-values Get metadata values for a key

    Loading…

  • GET /api/v1/results/{id}/result-ids Get ordered evaluation result identities

    Loading…

  • GET /api/v1/results/{id}/results/filtered-ids Get filtered result IDs

    Loading…

  • GET /api/v1/results/{id}/results/{resultsId}/grading-activity Read grading activity

    Loading…

  • GET /api/v1/results/{id}/results/{resultsId}/rating Read current rating

    Loading…

  • GET /api/v1/results/{id}/table Get evaluation table data

    Loading…

  • GET /api/v1/results/{id}/table/location Locate an evaluation table row

    Loading…

  • GET /api/v1/results/{id}/traces Get evaluation traces

    Loading…

  • PATCH /api/v1/results/{id} Update evaluation

    Loading…

  • PATCH /api/v1/results/{id}/results/{resultsId}/rating Edit rating conditionally

    Loading…

  • POST /api/v1/results Upload evaluation

    Loading…

  • POST /api/v1/results/{id}/copy Copy evaluation

    Loading…

  • POST /api/v1/results/{id}/generateIssues Generate issues from an evaluation

    Loading…

  • POST /api/v1/results/{id}/results Add results

    Loading…

  • POST /api/v1/results/{id}/results/bulk-llm-regrade Bulk LLM regrade

    Loading…

  • POST /api/v1/results/{id}/results/bulk-rating Bulk rate results

    Loading…

  • POST /api/v1/results/{id}/results/{resultsId}/comment Add comment to result

    Loading…

  • POST /api/v1/results/{id}/results/{resultsId}/rating Rate result

    Loading…

  • POST /api/v1/results/{id}/share Share evaluation

    Loading…

  • PUT /api/v1/results/{id}/results/{resultsId}/tags Set result tags

    Loading…

Guardrails 26

  • DELETE /api/v1/guardrails/{id} Delete guardrail

    Loading…

  • DELETE /api/v1/guardrails/{id}/policies/{policyId} Delete a policy

    Loading…

  • DELETE /api/v1/guardrails/{id}/regex-rules/{ruleId} Delete a regex rule

    Loading…

  • DELETE /api/v1/guardrails/{id}/targets/{targetId} Remove a target from a guardrail

    Loading…

  • GET /api/v1/guardrails List guardrails

    Loading…

  • GET /api/v1/guardrails/issue-examples/{issueId} Get issue attack examples

    Loading…

  • GET /api/v1/guardrails/requests List guardrail requests

    Loading…

  • GET /api/v1/guardrails/requests/{id} Get guardrail request

    Loading…

  • GET /api/v1/guardrails/{id} Get guardrail

    Loading…

  • POST /api/v1/guardrails Create guardrail

    Loading…

  • POST /api/v1/guardrails/adaptive Adaptive prompting

    Loading…

  • POST /api/v1/guardrails/guard Detect prompt injection

    Loading…

  • POST /api/v1/guardrails/harm Detect harmful content

    Loading…

  • POST /api/v1/guardrails/pii Detect PII

    Loading…

  • POST /api/v1/guardrails/test-policy Test a draft policy

    Loading…

  • POST /api/v1/guardrails/test-policy-examples Test a policy against issue examples

    Loading…

  • POST /api/v1/guardrails/{id}/analyze Analyze a prompt with the target guardrail

    Loading…

  • POST /api/v1/guardrails/{id}/evaluate Evaluate target guardrails

    Loading…

  • POST /api/v1/guardrails/{id}/generate-policy-for-issue Generate policy for issue

    Loading…

  • POST /api/v1/guardrails/{id}/policies Create a policy

    Loading…

  • POST /api/v1/guardrails/{id}/regex-rules Create a regex rule

    Loading…

  • POST /api/v1/guardrails/{id}/targets Add a target to a guardrail

    Loading…

  • POST /api/v1/guardrails/{id}/test Test a guardrail

    Loading…

  • PUT /api/v1/guardrails/{id} Update guardrail

    Loading…

  • PUT /api/v1/guardrails/{id}/policies/{policyId} Update a policy

    Loading…

  • PUT /api/v1/guardrails/{id}/regex-rules/{ruleId} Update a regex rule

    Loading…

Red Team 26

  • DELETE /api/v1/custom-policies/{id} Delete custom policy

    Loading…

  • DELETE /api/v1/redteam/configs Bulk delete red team configs

    Loading…

  • DELETE /api/v1/redteam/configs/{configId} Delete red team config

    Loading…

  • DELETE /api/v1/redteam/plugins/severity-overrides/{id} Delete severity override

    Loading…

  • DELETE /api/v1/redteam/plugins/{id} Delete plugin collection

    Loading…

  • GET /api/v1/custom-policies List custom policies

    Loading…

  • GET /api/v1/custom-policies/{id} Get custom policy

    Loading…

  • GET /api/v1/redteam/configs List red team configs

    Loading…

  • GET /api/v1/redteam/configs/table List a page of red team configs for the table

    Loading…

  • GET /api/v1/redteam/configs/{configId} Get red team config

    Loading…

  • GET /api/v1/redteam/configs/{configId}/unified Get unified config

    Loading…

  • GET /api/v1/redteam/plugins List plugin collections

    Loading…

  • GET /api/v1/redteam/plugins/severity-overrides List severity overrides

    Loading…

  • GET /api/v1/redteam/plugins/severity-overrides/{id} Get severity override

    Loading…

  • GET /api/v1/redteam/plugins/{id} Get plugin collection

    Loading…

  • PATCH /api/v1/custom-policies/scope Bulk update org-scope for custom policies

    Loading…

  • PATCH /api/v1/redteam/plugins/{id} Update plugin collection

    Loading…

  • POST /api/v1/custom-policies Create custom policies

    Loading…

  • POST /api/v1/custom-policies/generate Generate custom policies

    Loading…

  • POST /api/v1/redteam/configs Create red team config

    Loading…

  • POST /api/v1/redteam/generate-test Generate a single red team test case

    Loading…

  • POST /api/v1/redteam/plugins Create plugin collection

    Loading…

  • POST /api/v1/redteam/plugins/severity-overrides Create severity override

    Loading…

  • PUT /api/v1/custom-policies/{id} Update custom policy

    Loading…

  • PUT /api/v1/redteam/configs/{configId} Update red team config

    Loading…

  • PUT /api/v1/redteam/plugins/severity-overrides/{id} Update severity override

    Loading…

Organizations 22

  • DELETE /api/v1/organizations/{id}/service-accounts/{accountId} Delete service account

    Loading…

  • DELETE /api/v1/organizations/{id}/service-accounts/{accountId}/keys/{keyId} Revoke service account key

    Loading…

  • DELETE /api/v1/organizations/{id}/service-accounts/{accountId}/legacy-key Revoke legacy service account keys

    Loading…

  • DELETE /api/v1/organizations/{id}/users/{userId} Remove user

    Loading…

  • GET /api/v1/organizations List organizations

    Loading…

  • GET /api/v1/organizations/{id} Get organization

    Loading…

  • GET /api/v1/organizations/{id}/service-accounts List service accounts

    Loading…

  • GET /api/v1/organizations/{id}/service-accounts/{accountId}/keys List service account keys

    Loading…

  • GET /api/v1/organizations/{id}/users List organization users

    Loading…

  • GET /api/v1/organizations/{organizationId}/overview/targets Get target vulnerability status overview

    Loading…

  • GET /api/v1/organizations/{organizationId}/overview/vulnerabilities Get organization vulnerability severity counts

    Loading…

  • GET /api/v1/organizations/{organizationId}/overview/vulnerability-history Get organization vulnerability history

    Loading…

  • GET /api/v1/organizations/{organizationId}/probe-usage Get probe usage history

    Loading…

  • GET /api/v1/organizations/{organizationId}/usage Get organization usage

    Loading…

  • PATCH /api/v1/organizations/{id} Patch organization

    Loading…

  • PATCH /api/v1/organizations/{id}/service-accounts/{accountId} Update service account admin status

    Loading…

  • POST /api/v1/organizations Create organization

    Loading…

  • POST /api/v1/organizations/{id}/service-accounts Create service account

    Loading…

  • POST /api/v1/organizations/{id}/service-accounts/{accountId}/keys Create service account key

    Loading…

  • POST /api/v1/organizations/{id}/users Add user with team/role

    Loading…

  • PUT /api/v1/organizations/{id} Update organization

    Loading…

  • PUT /api/v1/organizations/{id}/users/{userId}/admin Set admin status

    Loading…

Teams 19

  • DELETE /api/v1/teams/{id} Delete team

    Loading…

  • DELETE /api/v1/teams/{id}/members/{userId} Remove team member

    Loading…

  • DELETE /api/v1/teams/{id}/secrets/{secretId} Delete team secret

    Loading…

  • GET /api/v1/teams List teams

    Loading…

  • GET /api/v1/teams/{id} Get team

    Loading…

  • GET /api/v1/teams/{id}/inference-providers Get team inference provider overrides

    Loading…

  • GET /api/v1/teams/{id}/members List team members

    Loading…

  • GET /api/v1/teams/{id}/redteam-provider Get team red team provider override

    Loading…

  • GET /api/v1/teams/{id}/secrets List team secrets

    Loading…

  • GET /api/v1/teams/{id}/secrets/{recordId}/value Reveal team secret value

    Loading…

  • GET /api/v1/teams/{id}/usage Get team probe usage

    Loading…

  • PATCH /api/v1/teams/{id}/secrets/{secretId} Update team secret

    Loading…

  • POST /api/v1/teams Create team

    Loading…

  • POST /api/v1/teams/{id}/members Add team member

    Loading…

  • POST /api/v1/teams/{id}/secrets Create team secret

    Loading…

  • PUT /api/v1/teams/{id} Update team

    Loading…

  • PUT /api/v1/teams/{id}/inference-providers/{key} Update team inference provider override

    Loading…

  • PUT /api/v1/teams/{id}/members/{userId} Update member role

    Loading…

  • PUT /api/v1/teams/{id}/redteam-provider Update team red team provider override

    Loading…

Providers 16

  • DELETE /api/v1/providers/{id} Delete provider

    Loading…

  • DELETE /api/v1/providers/{id}/file Delete provider file (on-prem only)

    Loading…

  • GET /api/v1/providers List providers

    Loading…

  • GET /api/v1/providers/{id} Get provider

    Loading…

  • GET /api/v1/providers/{id}/file Get provider file (on-prem only)

    Loading…

  • GET /api/v1/providers/{id}/move-team/preview Preview moving provider to another team

    Loading…

  • PATCH /api/v1/providers/{id} Update provider

    Loading…

  • POST /api/v1/http-provider-generator Generate an HTTP provider configuration

    Loading…

  • POST /api/v1/providers Create provider

    Loading…

  • POST /api/v1/providers/playground Chat playground for a provider (on-prem only)

    Loading…

  • POST /api/v1/providers/test Test HTTP provider

    Loading…

  • POST /api/v1/providers/test-provider Test provider configuration (on-prem only)

    Loading…

  • POST /api/v1/providers/test-session Test provider session handling (on-prem only)

    Loading…

  • POST /api/v1/providers/{id}/discover Discover provider purpose (on-prem only)

    Loading…

  • POST /api/v1/providers/{id}/file Upload provider file (on-prem only)

    Loading…

  • POST /api/v1/providers/{id}/move-team Move provider to another team

    Loading…

Red Team Grading Guidelines 13

  • DELETE /api/v1/redteam/grading-guidelines/{id} Delete grading guideline

    Loading…

  • GET /api/v1/redteam/grading-guidelines List grading guidelines

    Loading…

  • GET /api/v1/redteam/grading-guidelines/{id} Get grading guideline

    Loading…

  • GET /api/v1/redteam/grading-guidelines/{id}/extractions List grading guideline extractions

    Loading…

  • PATCH /api/v1/redteam/grading-guidelines/{id} Update grading guideline

    Loading…

  • PATCH /api/v1/redteam/grading-guidelines/{id}/extractions/{extractionId} Update extracted guidance text

    Loading…

  • POST /api/v1/redteam/grading-guidelines Create grading guideline

    Loading…

  • POST /api/v1/redteam/grading-guidelines/pdf/extract-text Extract text from PDF

    Loading…

  • POST /api/v1/redteam/grading-guidelines/{id}/extract-all Extract guidance for all plugins (async)

    Loading…

  • POST /api/v1/redteam/grading-guidelines/{id}/extract-failed Retry failed guidance extractions

    Loading…

  • POST /api/v1/redteam/grading-guidelines/{id}/extract/{pluginId} Extract guidance for single plugin

    Loading…

  • POST /api/v1/redteam/grading-guidelines/{id}/force-reset Force reset a stuck grading guideline extraction

    Loading…

  • POST /api/v1/redteam/grading-guidelines/{id}/reprocess Clear extracted guidance for reprocessing

    Loading…

Issues 11

  • GET /api/v1/issues List issues

    Loading…

  • GET /api/v1/issues/providers List issue providers

    Loading…

  • GET /api/v1/issues/{id} Get issue

    Loading…

  • GET /api/v1/issues/{id}/evalResults List issue eval results

    Loading…

  • GET /api/v1/issues/{id}/remediation Get issue remediation

    Loading…

  • PATCH /api/v1/issues/{id} Update issue

    Loading…

  • POST /api/v1/issues/export/colang Export issues as Colang

    Loading…

  • POST /api/v1/issues/export/csv Export issue CSV with selected fields

    Loading…

  • POST /api/v1/issues/export/detailed Export detailed issue CSV

    Loading…

  • POST /api/v1/issues/{id}/comment Add issue comment

    Loading…

  • POST /api/v1/issues/{id}/export/csv Export test cases for an issue

    Loading…

Users 11

  • GET /api/v1/users/me Get current user

    Loading…

  • GET /api/v1/users/me/abilities Get user abilities

    Loading…

  • GET /api/v1/users/me/organizations List my organizations

    Loading…

  • GET /api/v1/users/me/teams List my teams

    Loading…

  • GET /api/v1/users/status Get user status

    Loading…

  • GET /api/v1/users/{id}/teams Get user teams

    Loading…

  • POST /api/v1/users/login Public-mode login

    Loading…

  • POST /api/v1/users/me/invites/accept Accept an invite

    Loading…

  • POST /api/v1/users/me/invites/preview Preview an invite

    Loading…

  • POST /api/v1/users/me/reset-password Request current-user password reset

    Loading…

  • POST /api/v1/users/me/switch-organization Switch organization

    Loading…

Code Scan 10

  • GET /api/v1/code-scan/feedback/{feedbackToken} Get code-scan comment feedback page data

    Loading…

  • GET /api/v1/code-scans/setup/github/callback Complete GitHub installation ownership verification

    Loading…

  • GET /api/v1/code-scans/setup/installation/{installationId} Get code-scan installation setup details

    Loading…

  • GET /api/v1/code-scans/setup/redirect Handle GitHub App setup redirect

    Loading…

  • PATCH /api/v1/code-scan/feedback/{feedbackToken} Update code-scan comment feedback details

    Loading…

  • POST /api/v1/code-scan/feedback/{feedbackToken} Submit code-scan comment feedback

    Loading…

  • POST /api/v1/code-scans/setup/confirm Confirm a code-scan GitHub App installation

    Loading…

  • POST /api/v1/code-scans/setup/create-prs Start creating code-scan setup pull requests

    Loading…

  • POST /api/v1/code-scans/setup/set-email Set contact email for a code-scan installation

    Loading…

  • POST /api/v1/webhooks/github-code-scan Receive GitHub App webhooks for code scanning

    Loading…

Intake 9

  • DELETE /api/v1/intake/admin/{id} Delete an intake submission

    Loading…

  • GET /api/v1/intake List intake submissions

    Loading…

  • GET /api/v1/intake/admin/{id} Get an intake submission

    Loading…

  • GET /api/v1/intake/admin/{id}/config Download on-prem config generated from an intake submission

    Loading…

  • GET /api/v1/intake/{token} Get public intake form data

    Loading…

  • PATCH /api/v1/intake/admin/{id} Update an intake submission

    Loading…

  • POST /api/v1/intake Create an intake link

    Loading…

  • POST /api/v1/intake/admin/{id}/convert Mark an intake submission as converted

    Loading…

  • POST /api/v1/intake/{token} Submit public intake form data

    Loading…

Eval Configs 8

  • DELETE /api/v1/eval/configs Bulk delete eval configs

    Loading…

  • DELETE /api/v1/eval/configs/{configId} Delete eval config

    Loading…

  • GET /api/v1/eval/configs List eval configs

    Loading…

  • GET /api/v1/eval/configs/{configId} Get eval config

    Loading…

  • GET /api/v1/eval/configs/{configId}/unified Get unified eval config

    Loading…

  • POST /api/v1/eval/configs Create eval config

    Loading…

  • POST /api/v1/eval/configs/import Import eval config from YAML

    Loading…

  • PUT /api/v1/eval/configs/{configId} Update eval config

    Loading…

Grading Guidance 8

  • DELETE /api/v1/grading-guidance/{id} Delete grading guidance

    Loading…

  • GET /api/v1/grading-guidance List grading guidance

    Loading…

  • GET /api/v1/grading-guidance/by-config/{configId} List grading guidance by config

    Loading…

  • GET /api/v1/grading-guidance/{id} Get grading guidance

    Loading…

  • POST /api/v1/grading-guidance Create grading guidance

    Loading…

  • POST /api/v1/grading-guidance/{id}/link-config/{configId} Link grading guidance to config

    Loading…

  • PUT /api/v1/grading-guidance/{id} Update grading guidance

    Loading…

Webhooks 7

  • DELETE /api/v1/webhooks/{webhookId} Delete webhook

    Loading…

  • GET /api/v1/webhooks List webhooks

    Loading…

  • GET /api/v1/webhooks/event-types List webhook event types

    Loading…

  • GET /api/v1/webhooks/{webhookId} Get webhook

    Loading…

  • POST /api/v1/webhooks Create webhook

    Loading…

  • POST /api/v1/webhooks/{webhookId}/regenerate-secret Regenerate webhook secret

    Loading…

  • PUT /api/v1/webhooks/{webhookId} Update webhook

    Loading…

Dashboard 6

  • GET /api/v1/dashboard/evals List red team eval prompt stats

    Loading…

  • GET /api/v1/dashboard/issuesPerDay Get open issue counts by day and severity

    Loading…

  • GET /api/v1/dashboard/scans List red team scan history

    Loading…

  • GET /api/v1/dashboard/scans/admin List organization scan history for admins

    Loading…

  • GET /api/v1/dashboard/scans/admin/statuses Read a bounded batch of organization job statuses

    Loading…

  • GET /api/v1/dashboard/targets List target vulnerability status summaries

    Loading…

Grading Examples 6

  • DELETE /api/v1/grading-examples/{id} Delete grading example

    Loading…

  • GET /api/v1/grading-examples List grading examples

    Loading…

  • GET /api/v1/grading-examples/{id} Get grading example

    Loading…

  • PATCH /api/v1/grading-examples/{id} Update grading example

    Loading…

  • POST /api/v1/grading-examples Create grading example

    Loading…

  • POST /api/v1/grading-examples/mutations Apply or replay a grading-example change

    Loading…

Jobs 5

  • GET /api/v1/jobs List jobs

    Loading…

  • GET /api/v1/jobs/{jobId} Get job

    Loading…

  • GET /api/v1/jobs/{jobId}/logs Stream job logs

    Loading…

  • POST /api/v1/jobs Start job

    Loading…

  • POST /api/v1/jobs/{jobId}/stop Stop job

    Loading…

Model Audits 5

  • DELETE /api/v1/model-audits/{scanId} Delete model audit

    Loading…

  • GET /api/v1/model-audits List model audits

    Loading…

  • GET /api/v1/model-audits/{scanId} Get model audit

    Loading…

  • POST /api/v1/model-audits/batch-exists Check model audit existence

    Loading…

  • POST /api/v1/model-audits/share Share model audit

    Loading…

Result Tags 5

  • DELETE /api/v1/organizations/{organizationId}/result-tags/{tagId} Delete result tag

    Loading…

  • GET /api/v1/organizations/{organizationId}/result-tags List result tags

    Loading…

  • GET /api/v1/organizations/{organizationId}/result-tags/{tagId}/results List linked eval results

    Loading…

  • PATCH /api/v1/organizations/{organizationId}/result-tags/{tagId} Update result tag

    Loading…

  • POST /api/v1/organizations/{organizationId}/result-tags Create result tag

    Loading…

Roles 5

  • DELETE /api/v1/organizations/{organizationId}/roles/{id} Delete role

    Loading…

  • GET /api/v1/organizations/{organizationId}/roles List organization roles

    Loading…

  • GET /api/v1/organizations/{organizationId}/roles/{id} Get role

    Loading…

  • POST /api/v1/organizations/{organizationId}/roles Create role

    Loading…

  • PUT /api/v1/organizations/{organizationId}/roles/{id} Update role

    Loading…

Setup 5

  • GET /api/v1/setup/status Get setup status

    Loading…

  • POST /api/v1/setup/admin Create first admin

    Loading…

  • POST /api/v1/setup/apply-key Apply deployment key

    Loading…

  • POST /api/v1/setup/complete Complete setup

    Loading…

  • POST /api/v1/setup/idp Configure identity provider

    Loading…

Tags 5

  • GET /api/v1/tags/keys List tag keys

    Loading…

  • GET /api/v1/tags/values List tag values

    Loading…

  • POST /api/v1/tags/bulk Bulk add tags

    Loading…

  • PUT /api/v1/tags/eval/{evalId} Set eval tags

    Loading…

  • PUT /api/v1/tags/job/{jobId} Set job tags

    Loading…

Tasks 5

  • GET /api/v1/task/health Check task route health

    Loading…

  • GET /api/v1/task/model-cost Get model cost and capacity metadata

    Loading…

  • GET /api/v1/task/version Get task service package version

    Loading…

  • POST /api/v1/task Execute a server-side generation task

    Loading…

  • POST /api/v1/task/harmful Generate harmful-test task output

    Loading…

Cli Targets 4

  • DELETE /api/v1/providers/cli/{teamId}/{id} Delete a CLI target

    Loading…

  • GET /api/v1/providers/cli/{teamId}/{id} Get a specific CLI target

    Loading…

  • GET /api/v1/providers/cli/{teamId}/{id}/move-team/preview Preview moving CLI target to another team

    Loading…

  • POST /api/v1/providers/cli/{teamId}/{id}/move-team Move CLI target to another team

    Loading…

Guardrails Dashboard 4

  • GET /api/v1/guardrails/dashboard/policy-metrics Get policy-level metrics

    Loading…

  • GET /api/v1/guardrails/dashboard/stats Get dashboard statistics

    Loading…

  • GET /api/v1/guardrails/dashboard/target-metrics Get target-level metrics

    Loading…

  • GET /api/v1/guardrails/dashboard/timeseries Get dashboard timeseries data

    Loading…

Server Settings 4

  • DELETE /api/v1/server-settings/{key} Delete an on-prem server setting

    Loading…

  • GET /api/v1/server-settings List on-prem server settings

    Loading…

  • GET /api/v1/server-settings/{key} Get an on-prem server setting

    Loading…

  • PUT /api/v1/server-settings/{key} Update an on-prem server setting

    Loading…

Api Tokens 3

  • GET /api/v1/api-tokens List API tokens

    Loading…

  • POST /api/v1/api-tokens/create Create API token

    Loading…

  • POST /api/v1/api-tokens/revoke Revoke API token

    Loading…

Auth 3

  • GET /api/v1/auth/fusionauth/identity-providers Fetch configured FusionAuth identity provider metadata

    Loading…

  • POST /api/v1/auth/fusionauth/token-proxy Exchange a FusionAuth authorization code for a Promptfoo session

    Loading…

  • POST /api/v1/auth/logout Destroy the current session

    Loading…

Guidance Review Jobs 3

  • GET /api/v1/regrade-jobs/eval/{evalId}/active Get active guidance review job for an eval

    Loading…

  • GET /api/v1/regrade-jobs/{jobId}/status Get guidance review job status

    Loading…

  • POST /api/v1/regrade-jobs/{evalId} Start a guidance review job

    Loading…

Reevaluation Jobs 3

  • GET /api/v1/reeval-jobs/eval/{evalId}/active Get the active re-evaluation job for an evaluation

    Loading…

  • GET /api/v1/reeval-jobs/{jobId}/status Get re-evaluation job status

    Loading…

  • POST /api/v1/reeval-jobs/{evalId} Start re-evaluating an evaluation

    Loading…

Remediation Reports 3

  • GET /api/v1/evals/{evalId}/remediation-report Get a remediation report for an evaluation

    Loading…

  • POST /api/v1/evals/{evalId}/remediation-report/harden-prompt Harden a system prompt using remediation guidance

    Loading…

  • POST /api/v1/evals/{evalId}/remediation-report/regenerate Regenerate a remediation report

    Loading…

System 3

  • GET /health Check system health

    Loading…

  • GET /static/openapi.json Get OpenAPI document

    Loading…

  • GET /version Get server version

    Loading…

Blobs 2

  • GET /api/blobs/{hash} Download a stored blob by hash

    Loading…

  • POST /api/blobs Upload a blob

    Loading…

Guardrail Jobs 2

  • GET /api/v1/guardrail-jobs/{jobId}/status Get guardrail generation job status

    Loading…

  • POST /api/v1/guardrail-jobs/generate/{targetId} Generate guardrail from red team vulnerabilities

    Loading…

Reports 2

  • GET /api/v1/reports/team-activity Team activity report

    Loading…

  • GET /api/v1/reports/vulnerability-posture Vulnerability posture report

    Loading…

Audit Logs 1

  • GET /api/v1/audit-logs List audit logs

    Loading…

Config 1

  • GET /api/v1/config Get server and client configuration flags

    Loading…

Datasets 1

  • GET /api/v1/datasets List datasets

    Loading…

License 1

  • GET /api/v1/license Get license status

    Loading…

Permissions 1

  • POST /api/v1/permissions/check Validate whether a config can run with the requested providers and targets

    Loading…

Prompts 1

  • GET /api/v1/prompts List prompts

    Loading…

Traces 1

  • GET /api/v1/traces/evaluation/{evaluationId} List traces for an evaluation

    Loading…

browse all tools → score card for your toolchain →