# neo ## Docs - [Check pre-installation requirements](https://docs.neo.projectdiscovery.io/api-reference/agent-directory/check-pre-installation-requirements.md): Check if the current user can install an agent by its UUID. Returns information about required environment variables, packages, and estimated installation time. - [Get public agent details from directory](https://docs.neo.projectdiscovery.io/api-reference/agent-directory/get-public-agent-details-from-directory.md): Get full details of a specific public agent from the directory by its UUID, including creator attribution and installation status. - [Install (fork) a public agent from directory](https://docs.neo.projectdiscovery.io/api-reference/agent-directory/install-fork-a-public-agent-from-directory.md): Install a public agent by its UUID as an independent copy. The agent will be installed with the same agent_id but owned by the current user. - [List public agents from directory](https://docs.neo.projectdiscovery.io/api-reference/agent-directory/list-public-agents-from-directory.md): Browse all public agents from the directory with pagination, tag filtering, and text search support. - [Create user agent](https://docs.neo.projectdiscovery.io/api-reference/agents/create-user-agent.md): Create a new custom agent for the current user - [Delete user agent](https://docs.neo.projectdiscovery.io/api-reference/agents/delete-user-agent.md): Delete a user agent. - [Get agent details](https://docs.neo.projectdiscovery.io/api-reference/agents/get-agent-details.md): Get detailed information about a specific agent (native or user). - [Get user agent](https://docs.neo.projectdiscovery.io/api-reference/agents/get-user-agent.md): Get details of a specific user agent - [List default agents](https://docs.neo.projectdiscovery.io/api-reference/agents/list-default-agents.md): List all default (native) agents. Use ?type=all to include user agents, or ?type=user for only user agents. - [List user agents](https://docs.neo.projectdiscovery.io/api-reference/agents/list-user-agents.md): List all agents created by the current user - [Update agent visibility](https://docs.neo.projectdiscovery.io/api-reference/agents/update-agent-visibility.md): Update the visibility of a user agent - [Update user agent](https://docs.neo.projectdiscovery.io/api-reference/agents/update-user-agent.md): Update an existing user agent - [Create API key](https://docs.neo.projectdiscovery.io/api-reference/api-keys/create-api-key.md): Create a new Neo API key for the authenticated user. - [Get API key](https://docs.neo.projectdiscovery.io/api-reference/api-keys/get-api-key.md): Retrieve the API key for the authenticated user. - [Rotate API key](https://docs.neo.projectdiscovery.io/api-reference/api-keys/rotate-api-key.md): Rotate the API key for the authenticated user. - [Create Stripe Customer Portal session](https://docs.neo.projectdiscovery.io/api-reference/billing/create-stripe-customer-portal-session.md): Creates a Stripe Customer Portal session for managing payment methods. Requires an existing Stripe customer ID. - [Get credit balance](https://docs.neo.projectdiscovery.io/api-reference/billing/get-credit-balance.md): Returns the current credit balance, usage, and expiry for the authenticated user or their team. - [List billing invoices](https://docs.neo.projectdiscovery.io/api-reference/billing/list-billing-invoices.md): Returns a list of Stripe invoices for the authenticated user's Stripe customer. Includes all credit purchase invoices. - [Purchase credits](https://docs.neo.projectdiscovery.io/api-reference/billing/purchase-credits.md): Buy Neo credits. First purchase redirects to Stripe Checkout (saves payment method). Subsequent purchases charge the saved payment method directly. Credits are added to the existing balance with a rolling 1-year expiry. - [Create or update a BYOK provider key](https://docs.neo.projectdiscovery.io/api-reference/byok/create-or-update-a-byok-provider-key.md): Create or update an API key for a specific provider. The key is encrypted at rest and validated against the provider's API before saving. - [Delete a BYOK provider key](https://docs.neo.projectdiscovery.io/api-reference/byok/delete-a-byok-provider-key.md): Delete the API key for a specific provider. If this is the last remaining provider key, the system automatically switches the model use mode back to "neo". - [List BYOK provider keys](https://docs.neo.projectdiscovery.io/api-reference/byok/list-byok-provider-keys.md): List all configured BYOK provider API keys for the current user or team. - [Set model use mode](https://docs.neo.projectdiscovery.io/api-reference/byok/set-model-use-mode.md): Set the model use mode to either "neo" (platform-managed) or "byok" (bring your own key). - [Validate a BYOK provider key](https://docs.neo.projectdiscovery.io/api-reference/byok/validate-a-byok-provider-key.md): Validate an API key against a provider without saving it. Useful for checking if a key is valid before committing. - [Get generation status](https://docs.neo.projectdiscovery.io/api-reference/codemaps/get-generation-status.md): Get the generation status and progress for an index. - [Get module structure](https://docs.neo.projectdiscovery.io/api-reference/codemaps/get-module-structure.md): Get the module tree and entry points for an index. - [List analyzed projects](https://docs.neo.projectdiscovery.io/api-reference/codemaps/list-analyzed-projects.md): List all analyzed project indexes. - [Trigger codebase analysis](https://docs.neo.projectdiscovery.io/api-reference/codemaps/trigger-codebase-analysis.md): Trigger structural analysis and codewiki generation for a codebase. - [Get module documentation](https://docs.neo.projectdiscovery.io/api-reference/codewiki/get-module-documentation.md): Get detailed codewiki documentation for a specific module. - [Get repository documentation](https://docs.neo.projectdiscovery.io/api-reference/codewiki/get-repository-documentation.md): Get the full repository documentation for an index. - [Get security audit](https://docs.neo.projectdiscovery.io/api-reference/codewiki/get-security-audit.md): Get the security audit for an index. - [Get threat model](https://docs.neo.projectdiscovery.io/api-reference/codewiki/get-threat-model.md): Get the threat model for an index. - [Get wiki overview](https://docs.neo.projectdiscovery.io/api-reference/codewiki/get-wiki-overview.md): Get the codewiki overview for an index. - [List wiki modules](https://docs.neo.projectdiscovery.io/api-reference/codewiki/list-wiki-modules.md): List codewiki modules for an index. - [Search wiki](https://docs.neo.projectdiscovery.io/api-reference/codewiki/search-wiki.md): Search the codewiki for an index. - [Browse files by directory](https://docs.neo.projectdiscovery.io/api-reference/files/browse-files-by-directory.md): Browser-style file listing with directory navigation support. - [Create or get public share](https://docs.neo.projectdiscovery.io/api-reference/files/create-or-get-public-share.md): Creates a new public share URL for a file, or returns the existing one if already shared. The URL is persistent and does not expire. - [Delete file(s)](https://docs.neo.projectdiscovery.io/api-reference/files/delete-files.md): Delete one or more files and their associated embeddings. - [Get file content](https://docs.neo.projectdiscovery.io/api-reference/files/get-file-content.md): Stream file content by key. Proxies the request to the sandbox and returns the raw file bytes with appropriate content-type header. - [Get shared file content](https://docs.neo.projectdiscovery.io/api-reference/files/get-shared-file-content.md): Stream the content of a publicly shared file. No authentication required — the token itself acts as the access control. - [List user files](https://docs.neo.projectdiscovery.io/api-reference/files/list-user-files.md): List all files in the user's workspace with optional filtering, search, and pagination. - [Move/rename file](https://docs.neo.projectdiscovery.io/api-reference/files/moverename-file.md): Move or rename a file to a new path. - [Rebuild file index](https://docs.neo.projectdiscovery.io/api-reference/files/rebuild-file-index.md): Start an asynchronous re-scan of the sandbox workspace, or a scoped workspace directory, and rebuild the SQLite-backed file metadata index. - [Regenerate share token](https://docs.neo.projectdiscovery.io/api-reference/files/regenerate-share-token.md): Regenerates (rotates) the public share token for a file, invalidating the old URL and creating a new one. - [Revoke public share](https://docs.neo.projectdiscovery.io/api-reference/files/revoke-public-share.md): Revokes the public share for a file, making the public URL inaccessible. - [Update file content](https://docs.neo.projectdiscovery.io/api-reference/files/update-file-content.md): Replace file content with new data. - [Upload file](https://docs.neo.projectdiscovery.io/api-reference/files/upload-file.md): Upload a file to the user's workspace. - [Claim GitHub installation](https://docs.neo.projectdiscovery.io/api-reference/github/claim-github-installation.md): Claim an unclaimed GitHub App installation. Requires GitHub OAuth to be connected first. - [Disconnect GitHub account](https://docs.neo.projectdiscovery.io/api-reference/github/disconnect-github-account.md): Disconnect the GitHub account from the current user's profile. - [Get a single pull request](https://docs.neo.projectdiscovery.io/api-reference/github/get-a-single-pull-request.md): Fetch a single pull request by number from GitHub. - [Get aggregated metadata for all repos in an installation](https://docs.neo.projectdiscovery.io/api-reference/github/get-aggregated-metadata-for-all-repos-in-an-installation.md): Fetch labels, branches, and collaborators aggregated across all repositories in an installation from the GitHub API. - [Get GitHub account status](https://docs.neo.projectdiscovery.io/api-reference/github/get-github-account-status.md): Check if the current user has connected their GitHub account via OAuth. - [Get installation activity feed](https://docs.neo.projectdiscovery.io/api-reference/github/get-installation-activity-feed.md): Get recent task activity for an installation, ordered by most recent first. - [Get org-wide config defaults](https://docs.neo.projectdiscovery.io/api-reference/github/get-org-wide-config-defaults.md): Get default configuration for an organization/installation. - [Get repository configuration](https://docs.neo.projectdiscovery.io/api-reference/github/get-repository-configuration.md): Get full PR review configuration for a specific repository. - [Get repository metadata from GitHub](https://docs.neo.projectdiscovery.io/api-reference/github/get-repository-metadata-from-github.md): Fetch labels, branches, and collaborators for a repository from the GitHub API. - [Get review metadata](https://docs.neo.projectdiscovery.io/api-reference/github/get-review-metadata.md): Get review metadata for a PR including task history. - [GitHub OAuth callback](https://docs.neo.projectdiscovery.io/api-reference/github/github-oauth-callback.md): Handle the GitHub OAuth callback. Redirects to the app with success or error status. Security is handled via the OAuth state cookie. - [Initiate GitHub OAuth](https://docs.neo.projectdiscovery.io/api-reference/github/initiate-github-oauth.md): Get a redirect URL to start the GitHub OAuth flow for connecting the user's GitHub account. - [List GitHub installations](https://docs.neo.projectdiscovery.io/api-reference/github/list-github-installations.md): List all GitHub App installations claimed by the current user. - [List pull requests for a repository](https://docs.neo.projectdiscovery.io/api-reference/github/list-pull-requests-for-a-repository.md): List pull requests for a repository with Neo review data. - [List repositories for an installation](https://docs.neo.projectdiscovery.io/api-reference/github/list-repositories-for-an-installation.md): List repositories for a GitHub App installation with optional search. - [Reset org-wide config defaults](https://docs.neo.projectdiscovery.io/api-reference/github/reset-org-wide-config-defaults.md): Reset org config defaults to empty (inherit system defaults). - [Reset repo config overrides](https://docs.neo.projectdiscovery.io/api-reference/github/reset-repo-config-overrides.md): Clear all repo-level config overrides. The repo will inherit org-level defaults. - [Search pull requests across repositories](https://docs.neo.projectdiscovery.io/api-reference/github/search-pull-requests-across-repositories.md): Search pull requests across all repositories in an installation, enriched with Neo review data. - [Trigger a task on a pull request](https://docs.neo.projectdiscovery.io/api-reference/github/trigger-a-task-on-a-pull-request.md): Trigger a review, investigation, summary, fix, or other task on a specific pull request. - [Update org-wide config defaults](https://docs.neo.projectdiscovery.io/api-reference/github/update-org-wide-config-defaults.md): Update default configuration for an organization/installation. These apply to all repos unless overridden. - [Update repository configuration](https://docs.neo.projectdiscovery.io/api-reference/github/update-repository-configuration.md): Update PR review settings for a specific repository. - [Connect a toolkit](https://docs.neo.projectdiscovery.io/api-reference/integrations/connect-a-toolkit.md): Start the OAuth or API-key connect flow for a toolkit. - [Create a toolkit config](https://docs.neo.projectdiscovery.io/api-reference/integrations/create-a-toolkit-config.md): Save a new provider configuration entry. - [Delete a toolkit config](https://docs.neo.projectdiscovery.io/api-reference/integrations/delete-a-toolkit-config.md): Delete a provider configuration entry by ID. - [Disconnect a toolkit](https://docs.neo.projectdiscovery.io/api-reference/integrations/disconnect-a-toolkit.md): Disconnect a connected account. - [Get active integration provider](https://docs.neo.projectdiscovery.io/api-reference/integrations/get-active-integration-provider.md): Returns which integration provider is active and whether it is configured. - [Get auth schemes for a toolkit](https://docs.neo.projectdiscovery.io/api-reference/integrations/get-auth-schemes-for-a-toolkit.md): Get available authentication methods for a toolkit. - [Get toolkit config options](https://docs.neo.projectdiscovery.io/api-reference/integrations/get-toolkit-config-options.md): Fetch provider-specific configuration options (projects, teams, repos, statuses, etc.) from the connected account. - [List integration toolkits](https://docs.neo.projectdiscovery.io/api-reference/integrations/list-integration-toolkits.md): List all available toolkits with per-user connection status. - [List saved toolkit configs](https://docs.neo.projectdiscovery.io/api-reference/integrations/list-saved-toolkit-configs.md): List all saved configurations for a toolkit. - [Update a toolkit config](https://docs.neo.projectdiscovery.io/api-reference/integrations/update-a-toolkit-config.md): Update an existing provider configuration entry by ID. - [Add comment](https://docs.neo.projectdiscovery.io/api-reference/issues/add-comment.md): Add a comment to an issue. - [Bulk create issues](https://docs.neo.projectdiscovery.io/api-reference/issues/bulk-create-issues.md): Create multiple issues in a single request. - [Bulk delete issues](https://docs.neo.projectdiscovery.io/api-reference/issues/bulk-delete-issues.md): Delete multiple issues by IDs, filters, or both. - [Bulk update issues](https://docs.neo.projectdiscovery.io/api-reference/issues/bulk-update-issues.md): Update multiple issues by IDs, filters, or both. - [Create issue](https://docs.neo.projectdiscovery.io/api-reference/issues/create-issue.md): Create a single issue. - [Create or update issue asset](https://docs.neo.projectdiscovery.io/api-reference/issues/create-or-update-issue-asset.md): Add or update an affected asset on an issue (deduped on issue_id + host + port + target). - [Delete issue](https://docs.neo.projectdiscovery.io/api-reference/issues/delete-issue.md): Delete an issue. - [Delete issue asset](https://docs.neo.projectdiscovery.io/api-reference/issues/delete-issue-asset.md): Remove a specific asset from an issue. - [Export issues](https://docs.neo.projectdiscovery.io/api-reference/issues/export-issues.md): Export issues as CSV or JSON. Supports the same filters as list issues, including task_id. JSON responses use a versioned envelope with exported_at, evidence_schema_version defaults, and normalized reproduction_steps for downstream systems. - [Get issue creation config](https://docs.neo.projectdiscovery.io/api-reference/issues/get-issue-creation-config.md): Get the issue creation policy/rules - [Get issue detail](https://docs.neo.projectdiscovery.io/api-reference/issues/get-issue-detail.md): Get detailed information about a specific issue. - [Get issue statistics](https://docs.neo.projectdiscovery.io/api-reference/issues/get-issue-statistics.md): Get aggregated issue statistics by severity, status, source, priority, and type. - [Get issue timeline](https://docs.neo.projectdiscovery.io/api-reference/issues/get-issue-timeline.md): Get merged changelogs and comments for an issue, ordered by time. - [List issue assets](https://docs.neo.projectdiscovery.io/api-reference/issues/list-issue-assets.md): List all assets (affected targets) attached to an issue. - [List issues](https://docs.neo.projectdiscovery.io/api-reference/issues/list-issues.md): List issues with optional filters and pagination. - [Update issue](https://docs.neo.projectdiscovery.io/api-reference/issues/update-issue.md): Update a single issue. Only provided fields are updated. - [Update issue asset](https://docs.neo.projectdiscovery.io/api-reference/issues/update-issue-asset.md): Update status or metadata of a specific issue asset. - [Update issue creation config](https://docs.neo.projectdiscovery.io/api-reference/issues/update-issue-creation-config.md): Create or update the issue creation policy/rules - [Index content into knowledge base](https://docs.neo.projectdiscovery.io/api-reference/knowledge/index-content-into-knowledge-base.md): Upload and index content (from text or URLs) into your personal knowledge base with hybrid search support - [List knowledge chunks](https://docs.neo.projectdiscovery.io/api-reference/knowledge/list-knowledge-chunks.md): Retrieve code chunks from indexed knowledge bases with pagination - [List knowledge collections](https://docs.neo.projectdiscovery.io/api-reference/knowledge/list-knowledge-collections.md): Get available knowledge collections. By default returns all collections (user + global). Use is_global parameter to filter. - [Search knowledge](https://docs.neo.projectdiscovery.io/api-reference/knowledge/search-knowledge.md): Perform semantic search across indexed code with automatic global fallback - [Create global working memory](https://docs.neo.projectdiscovery.io/api-reference/memory/create-global-working-memory.md): Create the current user's global working memory (user info and preferences). Returns 409 if memory already exists. Accepts partial fields. - [Create task working memory](https://docs.neo.projectdiscovery.io/api-reference/memory/create-task-working-memory.md): Create the working memory for a specific task. Returns 409 if memory already exists for this task. Accepts partial fields. - [Get global working memory](https://docs.neo.projectdiscovery.io/api-reference/memory/get-global-working-memory.md): Retrieve the current user's global (persistent) working memory containing user info and preferences. - [Get task working memory](https://docs.neo.projectdiscovery.io/api-reference/memory/get-task-working-memory.md): Retrieve the working memory for a specific task (insights, facts, todos, tracked files). - [Update global working memory](https://docs.neo.projectdiscovery.io/api-reference/memory/update-global-working-memory.md): Update the current user's global working memory (user info and preferences). Merges with existing data, or creates it if it does not exist. - [Update task working memory](https://docs.neo.projectdiscovery.io/api-reference/memory/update-task-working-memory.md): Update the working memory for a specific task. Merges with existing data, or creates it if it does not exist. - [List supported models](https://docs.neo.projectdiscovery.io/api-reference/models/list-supported-models.md): Returns all models supported for tasks. Use this endpoint to discover available models and their capabilities. - [Generate code from a captured request](https://docs.neo.projectdiscovery.io/api-reference/network-events/generate-code-from-a-captured-request.md): Render a captured request as runnable code (curl, Python, Go, etc.) or export as HAR. - [Get a single network event](https://docs.neo.projectdiscovery.io/api-reference/network-events/get-a-single-network-event.md): Retrieve full request/response details for a specific captured event. - [Get network traffic sitemap](https://docs.neo.projectdiscovery.io/api-reference/network-events/get-network-traffic-sitemap.md): Get domain-level, path-level, or tree summary of captured traffic. Useful for understanding the attack surface. - [List network events](https://docs.neo.projectdiscovery.io/api-reference/network-events/list-network-events.md): List captured HTTP traffic with filtering, sorting, and pagination. Supports HTTPQL queries, time range filtering, and field selection. Pass show_stats=true to get statistics instead of events. - [List tasks with captured traffic](https://docs.neo.projectdiscovery.io/api-reference/network-events/list-tasks-with-captured-traffic.md): List all tasks that have captured network events with summary statistics. - [Replay a captured request with optional edits](https://docs.neo.projectdiscovery.io/api-reference/network-events/replay-a-captured-request-with-optional-edits.md): Decrypts and replays a captured request with optional modifications (method, path, headers, body, JSON mutations). The destination host is pinned to the original capture — cannot be changed via edits. - [API Reference](https://docs.neo.projectdiscovery.io/api-reference/overview.md): Programmatic access to the Neo platform for automation, integration, and custom workflows. - [Add project member](https://docs.neo.projectdiscovery.io/api-reference/projects/add-project-member.md): Add a team member to the project. Only the project owner can add members. The user must be a member of the project owner's team. - [Create project](https://docs.neo.projectdiscovery.io/api-reference/projects/create-project.md): Create a new project. The creator is automatically added as an admin member. - [Delete project](https://docs.neo.projectdiscovery.io/api-reference/projects/delete-project.md): Delete a project. Only the project owner can delete. - [Get project](https://docs.neo.projectdiscovery.io/api-reference/projects/get-project.md): Get project details by ID. User must be owner, explicit member, or member of a team the project is shared with. - [List project members](https://docs.neo.projectdiscovery.io/api-reference/projects/list-project-members.md): List explicit members of a project. User must have project access through ownership, explicit membership, or team sharing. - [List projects](https://docs.neo.projectdiscovery.io/api-reference/projects/list-projects.md): List all projects where the user is the owner, an explicit member, or a member of a team the project is shared with. - [Remove project member](https://docs.neo.projectdiscovery.io/api-reference/projects/remove-project-member.md): Remove a member from the project. The project owner can remove any member. Members can remove themselves. - [Update project](https://docs.neo.projectdiscovery.io/api-reference/projects/update-project.md): Update project name or team sharing. Only the project owner can update. - [Copy a library prompt](https://docs.neo.projectdiscovery.io/api-reference/prompts/copy-a-library-prompt.md): Copy a library prompt into the user's personal collection. Creates an independent copy. - [Create a prompt](https://docs.neo.projectdiscovery.io/api-reference/prompts/create-a-prompt.md): Create a new prompt in the user's personal library. Created as private by default. - [Delete prompt](https://docs.neo.projectdiscovery.io/api-reference/prompts/delete-prompt.md): Delete a prompt owned by the user. - [Get library prompt details](https://docs.neo.projectdiscovery.io/api-reference/prompts/get-library-prompt-details.md): Get full details of a specific prompt from the library by its UUID. - [Get prompt details](https://docs.neo.projectdiscovery.io/api-reference/prompts/get-prompt-details.md): Get details of a specific prompt owned by the user. - [List prompt categories](https://docs.neo.projectdiscovery.io/api-reference/prompts/list-prompt-categories.md): List distinct categories with prompt counts. visibility=all (default) returns all visible categories, visibility=public returns public library categories, visibility=private returns user's own categories, visibility=team returns team categories. - [List prompts](https://docs.neo.projectdiscovery.io/api-reference/prompts/list-prompts.md): List prompts. visibility=public returns public prompts, visibility=private returns user's own, visibility=team returns team prompts, visibility=all (default) returns all visible. Supports search and category filters. - [Update prompt](https://docs.neo.projectdiscovery.io/api-reference/prompts/update-prompt.md): Update a prompt owned by the user. - [List sandboxes](https://docs.neo.projectdiscovery.io/api-reference/sandboxes/list-sandboxes.md): Returns your Neo-managed cloud sandbox and any self-hosted sandboxes you have installed. Self-hosted entries include available actions such as connect and disconnect. Cloud entries may include resource usage while running. - [Remove self-hosted sandbox](https://docs.neo.projectdiscovery.io/api-reference/sandboxes/remove-self-hosted-sandbox.md): Unlinks a self-hosted sandbox from your account. Re-install and register the host again to add it back. - [Run sandbox action](https://docs.neo.projectdiscovery.io/api-reference/sandboxes/run-sandbox-action.md): For Neo-managed cloud sandboxes: pause, resume, or start using the id from the list response. - [Set cloud sandbox as default](https://docs.neo.projectdiscovery.io/api-reference/sandboxes/set-cloud-sandbox-as-default.md): Sets the Neo-managed cloud sandbox as your default for new tasks. - [Start cloud sandbox](https://docs.neo.projectdiscovery.io/api-reference/sandboxes/start-cloud-sandbox.md): Starts your Neo-managed cloud sandbox when it has not been provisioned yet or needs to be restarted after a failure. Use this when the cloud entry in the list has no id yet. - [Update sandbox preferences](https://docs.neo.projectdiscovery.io/api-reference/sandboxes/update-sandbox-preferences.md): Update `is_default`, `purpose`, or `display_name` for a self-hosted install. - [Create schedule](https://docs.neo.projectdiscovery.io/api-reference/schedules/create-schedule.md): Create a new scheduled or one-time task. - [Delete schedule](https://docs.neo.projectdiscovery.io/api-reference/schedules/delete-schedule.md): Permanently delete a schedule. This cannot be undone. Pending runs will be canceled. - [Get execution history](https://docs.neo.projectdiscovery.io/api-reference/schedules/get-execution-history.md): Get the execution history for a schedule. Includes status, timing, and any errors. - [Get schedule](https://docs.neo.projectdiscovery.io/api-reference/schedules/get-schedule.md): Get details of a specific schedule by ID, including execution history. - [List schedules](https://docs.neo.projectdiscovery.io/api-reference/schedules/list-schedules.md): Get schedules for the authenticated user or project. - [Pause schedule](https://docs.neo.projectdiscovery.io/api-reference/schedules/pause-schedule.md): Pause an active schedule. The schedule will not execute until resumed. - [Resume schedule](https://docs.neo.projectdiscovery.io/api-reference/schedules/resume-schedule.md): Resume a paused schedule. Next execution will be calculated. - [Run schedule now](https://docs.neo.projectdiscovery.io/api-reference/schedules/run-schedule-now.md): Start an immediate run for an active schedule without changing its cadence. - [Update schedule](https://docs.neo.projectdiscovery.io/api-reference/schedules/update-schedule.md): Update an existing schedule. Partial updates supported - only include fields to change. Note: Changing schedule_type (recurring ↔ one_time) is not supported; delete and recreate the schedule instead. - [Create secret](https://docs.neo.projectdiscovery.io/api-reference/secrets/create-secret.md): Store a new encrypted secret for the authenticated user. - [Delete secret](https://docs.neo.projectdiscovery.io/api-reference/secrets/delete-secret.md): Permanently delete a secret by ID. - [List secrets](https://docs.neo.projectdiscovery.io/api-reference/secrets/list-secrets.md): Retrieve secrets for the authenticated user or a project. - [Update secret metadata](https://docs.neo.projectdiscovery.io/api-reference/secrets/update-secret-metadata.md): Update mutable metadata for a secret by ID. - [List all skills](https://docs.neo.projectdiscovery.io/api-reference/skills/list-all-skills.md): List all global skills with optional search and category filters. - [Claim pending Slack installation](https://docs.neo.projectdiscovery.io/api-reference/slack/claim-pending-slack-installation.md): Claim a pending Slack Marketplace installation for the current Neo team. - [Disconnect Slack installation](https://docs.neo.projectdiscovery.io/api-reference/slack/disconnect-slack-installation.md): Disconnect a Slack workspace installation from the current Neo team. Only team admins can remove it. - [Get Slack installation status](https://docs.neo.projectdiscovery.io/api-reference/slack/get-slack-installation-status.md): Check the Slack installation status for the current Neo team. - [Initiate Slack OAuth](https://docs.neo.projectdiscovery.io/api-reference/slack/initiate-slack-oauth.md): Get a redirect URL to start the Slack OAuth V2 flow for installing the bot into a workspace for the current Neo team. - [Slack OAuth callback](https://docs.neo.projectdiscovery.io/api-reference/slack/slack-oauth-callback.md): Handle the Slack OAuth callback. Exchanges the authorization code for a bot token and creates or updates the workspace installation. Supports Neo-initiated installs via OAuth state and Slack Marketplace installs via setup-token claim redirects. - [Delete SSH key](https://docs.neo.projectdiscovery.io/api-reference/ssh-keys/delete-ssh-key.md): Permanently delete an SSH key pair by ID. - [Generate SSH key pair](https://docs.neo.projectdiscovery.io/api-reference/ssh-keys/generate-ssh-key-pair.md): Generate a new SSH key pair with the specified algorithm. The private key is encrypted and stored server-side. It is never returned to the caller. Only the public key and fingerprint are returned. - [Get SSH key](https://docs.neo.projectdiscovery.io/api-reference/ssh-keys/get-ssh-key.md): Get a single SSH key by ID. Returns public key and metadata only. - [List SSH keys](https://docs.neo.projectdiscovery.io/api-reference/ssh-keys/list-ssh-keys.md): List SSH key pairs for the authenticated user or a project. Private keys are never returned. Only public key, fingerprint, and metadata. - [Test SSH connection](https://docs.neo.projectdiscovery.io/api-reference/ssh-keys/test-ssh-connection.md): Test whether a saved SSH connection can authenticate using its stored encrypted credential. - [Update SSH key](https://docs.neo.projectdiscovery.io/api-reference/ssh-keys/update-ssh-key.md): Update SSH connection metadata. Password can only be updated for password-based SSH connections. Private keys are never returned. - [Submit a support ticket](https://docs.neo.projectdiscovery.io/api-reference/support/submit-a-support-ticket.md): Create a support ticket from the in-app Contact Support form. The backend enriches the request with the authenticated user's identity, plan tier, and org (resolved server-side, never trusted from the client) and opens a thread in Plain. Accepts multipart/form-data so binary attachments can be upload… - [Abort active task](https://docs.neo.projectdiscovery.io/api-reference/tasks/abort-active-task.md): Cancel an actively running stream for a specific task - [Approve or decline a suspended tool call](https://docs.neo.projectdiscovery.io/api-reference/tasks/approve-or-decline-a-suspended-tool-call.md): Submits an approval decision for a task whose agent stream is suspended waiting for user input (e.g., plan approval, ask_question). - [Create task (stream/json)](https://docs.neo.projectdiscovery.io/api-reference/tasks/create-task-streamjson.md): Create a new task or continue an existing one. Returns SSE by default, or JSON acknowledgement when requested. - [Delete task](https://docs.neo.projectdiscovery.io/api-reference/tasks/delete-task.md): Permanently delete a task and all its messages - [Delete task by ID](https://docs.neo.projectdiscovery.io/api-reference/tasks/delete-task-by-id.md): Permanently delete a task and all its messages using path parameter - [Get shared task (unauthenticated)](https://docs.neo.projectdiscovery.io/api-reference/tasks/get-shared-task-unauthenticated.md): Access a shared task without authentication. Similar to ChatGPT's share links. Works for tasks with visibility set to 'public' or 'unlisted'. Returns a read-only view. - [Get stream health status](https://docs.neo.projectdiscovery.io/api-reference/tasks/get-stream-health-status.md): Check the health status of an active stream including age and last activity - [Get task completion artifact](https://docs.neo.projectdiscovery.io/api-reference/tasks/get-task-completion-artifact.md): Returns the completion artifact for a finished task when completion_delivery=artifact was set, including a summary and issues. - [Get task details](https://docs.neo.projectdiscovery.io/api-reference/tasks/get-task-details.md): Retrieve task metadata and all messages for a specific task - [List tasks](https://docs.neo.projectdiscovery.io/api-reference/tasks/list-tasks.md): List the current user's own tasks with cursor-based pagination and optional status/scheduled filters. Team-visible tasks owned by teammates are excluded from this list by default, but may still be accessed directly by ID when authorized. - [Resume task stream](https://docs.neo.projectdiscovery.io/api-reference/tasks/resume-task-stream.md): Resume streaming for a specific task using path parameter - [Update task metadata](https://docs.neo.projectdiscovery.io/api-reference/tasks/update-task-metadata.md): Update task properties like title. Only the task owner can update. - [Update task visibility](https://docs.neo.projectdiscovery.io/api-reference/tasks/update-task-visibility.md): Change a task's visibility setting. Only the task owner can update visibility. - **private** (default): Only owner can access - **team**: Accessible by active members of the owner's team - **public**: Accessible by anyone with the task ID - [Accept invitation](https://docs.neo.projectdiscovery.io/api-reference/teams/accept-invitation.md): Accept a pending team invitation. - [Create team](https://docs.neo.projectdiscovery.io/api-reference/teams/create-team.md): Create a new team for the current user. Each user can only own one team. - [Delete team](https://docs.neo.projectdiscovery.io/api-reference/teams/delete-team.md): Delete the current user's team. This will remove all members and activity logs. - [Get team](https://docs.neo.projectdiscovery.io/api-reference/teams/get-team.md): Get the team owned by the current user, or null if no team exists. - [Invite member](https://docs.neo.projectdiscovery.io/api-reference/teams/invite-member.md): Invite a new member to the team by email. The member can be an existing or new user. - [List pending invitations](https://docs.neo.projectdiscovery.io/api-reference/teams/list-pending-invitations.md): List all pending team invitations for the current user. - [List team members](https://docs.neo.projectdiscovery.io/api-reference/teams/list-team-members.md): List all members of the current user's team. - [Remove member](https://docs.neo.projectdiscovery.io/api-reference/teams/remove-member.md): Remove a member from the team. Team admins or the member themselves can remove. - [Update member role](https://docs.neo.projectdiscovery.io/api-reference/teams/update-member-role.md): Update a team member's role. Only team admins can update roles. - [Update team](https://docs.neo.projectdiscovery.io/api-reference/teams/update-team.md): Update team settings. Team admins only. - [Get overall usage summary](https://docs.neo.projectdiscovery.io/api-reference/usage/get-overall-usage-summary.md): Get an overall usage summary with totals across all tasks. Includes total costs, task counts by status, usage breakdown by model, and time-based trends. - [Get task usage by ID](https://docs.neo.projectdiscovery.io/api-reference/usage/get-task-usage-by-id.md): Get detailed usage data for a specific task by its ID. Returns aggregated metrics across all streams within this task, including token counts, costs, tool calls, and execution times. - [List all stream usages](https://docs.neo.projectdiscovery.io/api-reference/usage/list-all-stream-usages.md): List usage data for individual streams. Each stream represents a single execution within a task. Use this endpoint for detailed per-stream analysis including cost, tool calls, and execution metrics. For aggregated task-level data, use GET /api/v1/usage/tasks instead. - [List all task usages](https://docs.neo.projectdiscovery.io/api-reference/usage/list-all-task-usages.md): List usage data for all tasks with aggregated metrics. Each task may contain multiple streams (executions), and this endpoint returns the combined totals for each task including cost, tool calls, and execution times. - [Get current user](https://docs.neo.projectdiscovery.io/api-reference/user/get-current-user.md): Get the current authenticated user's profile information including: - Email and role - Feature flags (neo_ai access, etc.) - User tag (if any) - Team membership (if user belongs to a team) - [List the current user's notification preferences](https://docs.neo.projectdiscovery.io/api-reference/user/list-the-current-users-notification-preferences.md): Returns the authenticated user's notification preferences for every known source. Sources without an explicit row default to enabled=true. - [Update one notification preference for the current user](https://docs.neo.projectdiscovery.io/api-reference/user/update-one-notification-preference-for-the-current-user.md): Upsert a single (source, enabled) pair for the authenticated user. The user_id is taken from the session and never from the request body. - [Agent architecture](https://docs.neo.projectdiscovery.io/concepts/agent-architecture.md): How Neo's orchestrator and specialized subagents coordinate to run complex security assessments - [Pricing & Cost Guide](https://docs.neo.projectdiscovery.io/concepts/cost.md): Understand how Neo's credit-based pricing works, how we keep costs low, and what your security workflows actually cost. - [Environment Variables](https://docs.neo.projectdiscovery.io/concepts/env-vars.md): Configure credentials and endpoints so Neo can connect to your tools and services - [Memory](https://docs.neo.projectdiscovery.io/concepts/memory.md): How Neo learns your environment and gets smarter over time - [Sandboxes](https://docs.neo.projectdiscovery.io/concepts/sandboxes.md): Fully isolated execution environments for safe security testing at scale - [Scheduling](https://docs.neo.projectdiscovery.io/concepts/scheduling.md): Run security tasks on a schedule with full agent capabilities, memory, and credential access - [Secrets](https://docs.neo.projectdiscovery.io/concepts/secrets.md): Encrypted credential management for authenticated security testing - [Security & Privacy](https://docs.neo.projectdiscovery.io/concepts/security-privacy.md) - [Skills](https://docs.neo.projectdiscovery.io/concepts/skills.md): Domain-specific knowledge guides that turn agents into specialists - [SSH Connections](https://docs.neo.projectdiscovery.io/concepts/ssh-connections.md): Run commands on remote hosts you control - [Verification](https://docs.neo.projectdiscovery.io/concepts/verification.md): How Neo independently proves every finding before it reaches your team - [Code audit](https://docs.neo.projectdiscovery.io/essentials/code-audit.md): Exhaustive code review: full architecture mapping, data-flow tracing, and validation - [Connecting Your Stack](https://docs.neo.projectdiscovery.io/essentials/connecting-your-stack.md): Connect your repositories, environments, and services so Neo can test your applications with full context. - [Pentest](https://docs.neo.projectdiscovery.io/essentials/pentest.md): Long-running, contextual pentest: full recon through exploitation with real-world impact proof - [Run your first workflow](https://docs.neo.projectdiscovery.io/essentials/quickstart.md) - [Vuln triage](https://docs.neo.projectdiscovery.io/essentials/vuln-triage.md): Cut through noise: rank findings by true exploitability and blast radius - [Why Neo](https://docs.neo.projectdiscovery.io/essentials/why-neo.md): Security infrastructure that lets teams scale their operations with LLMs without building or maintaining the plumbing - [Welcome to Neo](https://docs.neo.projectdiscovery.io/index.md) - [Overview](https://docs.neo.projectdiscovery.io/integrations/github.md): Bring Neo into your pull request workflow as a GitHub App that combines scanner pipelines, AI-powered code review, and live runtime validation. - [Admin & Permissions](https://docs.neo.projectdiscovery.io/integrations/github-admin-and-permissions.md): GitHub App permissions Neo requests, who can install vs use, the full per-repo and org configuration surface, gating, and the GitHub-side collaborator gate. - [Install & Connect](https://docs.neo.projectdiscovery.io/integrations/github-install-and-connect.md): Install the Neo GitHub App on an org or account, link your Neo team, and understand reconnect, switch-org, and disconnect behavior. - [Privacy & Support](https://docs.neo.projectdiscovery.io/integrations/github-privacy-and-support.md): How Neo handles GitHub data and where to go for support, privacy, legal, and trust information. - [Troubleshooting](https://docs.neo.projectdiscovery.io/integrations/github-troubleshooting.md): Diagnose missing installs, "already installed" confusion, auto-review not firing, collaborator-gate 403s, and webhook delivery issues. - [Usage](https://docs.neo.projectdiscovery.io/integrations/github-use-neo-on-github.md): How automatic reviews fire, what Neo posts on a PR, the full command list, incremental review with auto-resolve, and live validation. - [HackerOne](https://docs.neo.projectdiscovery.io/integrations/hackerone.md): Connect HackerOne to Neo for report triage and Triage Summary automation - [Linear](https://docs.neo.projectdiscovery.io/integrations/linear.md): Native Linear agent for vulnerability backlog, triage, retesting, and issue management - [Overview](https://docs.neo.projectdiscovery.io/integrations/slack.md): Use Neo directly in Slack to run security tasks, review findings, and continue investigations with your team. - [Admin & Permissions](https://docs.neo.projectdiscovery.io/integrations/slack-admin-and-permissions.md): Review the permissions Neo needs in Slack, how admins manage the workspace connection, and how channel-level behavior works. - [Install & Connect](https://docs.neo.projectdiscovery.io/integrations/slack-install-and-connect.md): Install the Neo Slack app, connect your workspace to Neo, and complete setup without ownership or permission confusion. - [Privacy & Support](https://docs.neo.projectdiscovery.io/integrations/slack-privacy-and-support.md): Understand how Neo handles Slack data and where to go for support, privacy, legal, and trust information. - [Troubleshooting](https://docs.neo.projectdiscovery.io/integrations/slack-troubleshooting.md): Diagnose Slack install states, reconnect problems, channel issues, and other common Neo-in-Slack edge cases. - [Usage](https://docs.neo.projectdiscovery.io/integrations/slack-use-neo-in-slack.md): Work with Neo in DMs and channels, use threads effectively, share files, and stop running tasks with reactions. - [Overview](https://docs.neo.projectdiscovery.io/platform/agents.md): Specialized agents that power Neo tasks, and tools to build your own - [GitHub Review Agent](https://docs.neo.projectdiscovery.io/platform/agents/analysis/github-review-agent.md): Automated security-focused pull request review with inline finding comments - [Summarizing Agent](https://docs.neo.projectdiscovery.io/platform/agents/analysis/summarizing-agent.md): Output condensation utility that surfaces security-relevant content from large tool outputs - [Verification Agent](https://docs.neo.projectdiscovery.io/platform/agents/analysis/verification-agent.md): Post-execution judge that validates findings, re-tests independently, and files confirmed issues - [Vuln Triage Agent](https://docs.neo.projectdiscovery.io/platform/agents/analysis/vuln-triage-agent.md): Source-agnostic vulnerability triage for HackerOne reports, scanner imports, and manual input - [Community Agents](https://docs.neo.projectdiscovery.io/platform/agents/community-agents.md): Discover and remix agents built by the security community - [Custom Agents](https://docs.neo.projectdiscovery.io/platform/agents/custom-agents.md): Build agents tailored to your environment, workflows, and security objectives - [CVE Intelligence Agent](https://docs.neo.projectdiscovery.io/platform/agents/discovery/cve-intelligence-agent.md): CVE research, exploit intelligence, and vulnerability database analysis - [Explore Agent](https://docs.neo.projectdiscovery.io/platform/agents/discovery/explore-agent.md): Pre-execution intelligence gathering and target reconnaissance for the Planner - [ProjectDiscovery Agent](https://docs.neo.projectdiscovery.io/platform/agents/discovery/projectdiscovery-agent.md): Asset discovery and intelligence using ProjectDiscovery Cloud Platform - [Recon Agent](https://docs.neo.projectdiscovery.io/platform/agents/discovery/recon-agent.md): Passive target intelligence and asset discovery using ProjectDiscovery tools - [Research Agent](https://docs.neo.projectdiscovery.io/platform/agents/discovery/research-agent.md): Cybersecurity intelligence gathering, CVE analysis, and real-time threat research - [Agent Swarm](https://docs.neo.projectdiscovery.io/platform/agents/orchestration/agent-swarm.md): Orchestration agent that coordinates specialized agents in parallel for complex, multi-phase assessments - [Planner Agent](https://docs.neo.projectdiscovery.io/platform/agents/orchestration/planner.md): Strategic planning agent that gathers intelligence and builds execution plans before action is taken - [Android Security Agent](https://docs.neo.projectdiscovery.io/platform/agents/testing/android-security-agent.md): Adaptive Android penetration testing on cloud-hosted rooted devices with Frida instrumentation - [API Security Agent](https://docs.neo.projectdiscovery.io/platform/agents/testing/api-security-agent.md): API discovery and security testing with OpenAPI and Swagger support - [Browser Agent](https://docs.neo.projectdiscovery.io/platform/agents/testing/browser-agent.md): Real browser automation for DOM-based testing, authenticated flows, and visual verification - [Deploy Agent](https://docs.neo.projectdiscovery.io/platform/agents/testing/deploy-agent.md): On-demand container orchestration for spinning up target applications and test environments - [Ghidra Agent](https://docs.neo.projectdiscovery.io/platform/agents/testing/ghidra-agent.md): Binary reverse engineering and vulnerability research powered by GhidraMCP - [iOS Security Agent](https://docs.neo.projectdiscovery.io/platform/agents/testing/ios-deep-security-agent.md): Advanced iOS security testing with jailbroken device access and deep Frida instrumentation - [Red Team Operator](https://docs.neo.projectdiscovery.io/platform/agents/testing/red-team-operator.md): Authorized adversary simulation and internal penetration testing with scope-aware execution - [Sandbox Agent](https://docs.neo.projectdiscovery.io/platform/agents/testing/sandbox-agent.md): Primary execution agent for hands-on security testing inside an isolated sandbox environment - [XSS Agent](https://docs.neo.projectdiscovery.io/platform/agents/testing/xss-agent.md): Cross-site scripting detection, context analysis, and blind XSS testing - [Automations](https://docs.neo.projectdiscovery.io/platform/automations.md): Schedule tasks to run automatically on a recurring or one-time basis - [Issues](https://docs.neo.projectdiscovery.io/platform/issues.md): A persistent vulnerability database that gets smarter with every run - [Projects](https://docs.neo.projectdiscovery.io/platform/projects.md): Organize tasks, issues, files, and team members around a shared security objective - [Prompt Library](https://docs.neo.projectdiscovery.io/platform/prompt-library.md): Save, organize, and reuse prompts across tasks and your team - [API Key](https://docs.neo.projectdiscovery.io/platform/settings/api-key.md): Authenticate programmatic access to Neo using your API key - [BYOK](https://docs.neo.projectdiscovery.io/platform/settings/byok.md): Bring your own LLM provider API keys to Neo - [Egress IP](https://docs.neo.projectdiscovery.io/platform/settings/egress-ip.md): Outbound IP addresses for allowlist configuration - [Models](https://docs.neo.projectdiscovery.io/platform/settings/models.md): Choose which AI model powers your Neo tasks - [Notifications](https://docs.neo.projectdiscovery.io/platform/settings/notifications.md): Configure how Neo reaches you for task updates and follow-up questions - [Secrets](https://docs.neo.projectdiscovery.io/platform/settings/secrets.md): Store credentials and tokens that Neo agents can use during tasks - [VPN](https://docs.neo.projectdiscovery.io/platform/settings/vpn.md): Connect Neo to your internal network for testing private targets - [Tasks and Modes](https://docs.neo.projectdiscovery.io/platform/tasks-and-modes.md): The fundamental unit of work in Neo, and how to control the depth of execution - [Overview](https://docs.neo.projectdiscovery.io/platform/tools.md): The capabilities Neo agents use to do real work, from pre-installed security binaries to tools you build yourself - [Custom Tools](https://docs.neo.projectdiscovery.io/platform/tools/custom-tools.md): Tools you write yourself to wrap internal APIs, proprietary tooling, and repeatable team workflows - [MCP Tools](https://docs.neo.projectdiscovery.io/platform/tools/mcp-tools.md): External tools connected to Neo agents over the Model Context Protocol - [Pre-installed Tools](https://docs.neo.projectdiscovery.io/platform/tools/pre-installed-tools.md): The security toolchain baked into every sandbox and invoked straight from the terminal - [Purpose-built Tools](https://docs.neo.projectdiscovery.io/platform/tools/purpose-built-tools.md): Over 40 native tools designed by ProjectDiscovery to handle the mechanical parts of security work - [APIs (REST, GraphQL)](https://docs.neo.projectdiscovery.io/use-cases/api-security.md) - [Application Pentesting](https://docs.neo.projectdiscovery.io/use-cases/application-pentest.md) - [External Attack Surface](https://docs.neo.projectdiscovery.io/use-cases/attack-surface-monitoring.md) - [Cloud & Infrastructure Testing](https://docs.neo.projectdiscovery.io/use-cases/cloud-infrastructure.md) - [PR Security Review](https://docs.neo.projectdiscovery.io/use-cases/code-reviews.md) - [Internal Network](https://docs.neo.projectdiscovery.io/use-cases/internal-network-pentest.md) - [Patch Validation & Regression Testing](https://docs.neo.projectdiscovery.io/use-cases/patch-validation.md): Verify that fixes actually hold, catch bypasses before production, and detect regressions across future releases. - [Security Reporting & Compliance](https://docs.neo.projectdiscovery.io/use-cases/security-reporting.md): Turn Neo's validated findings into reports for engineering, leadership, and auditors — with evidence that stands up to scrutiny. - [Threat Modeling](https://docs.neo.projectdiscovery.io/use-cases/threat-modeling.md) - [Vulnerability Triage](https://docs.neo.projectdiscovery.io/use-cases/vulnerability-review.md) ## OpenAPI Specs - [openapi](https://neo.api.projectdiscovery.io/api/openapi.json)