# Antigen Docs

> Build, integrate, and get help with Antigen.

## Docs

- [Antigen documentation](https://docs.antigen.sh/docs/index.md): Learn how Antigen maps your attack surface, runs offensive security agents, and verifies every fix.
- [Quick Start](https://docs.antigen.sh/docs/getting-started/quick-start.md): Get from signup to your first vulnerability in five minutes.
- [Concepts](https://docs.antigen.sh/docs/getting-started/concepts.md)
- [Asset Map](https://docs.antigen.sh/docs/asset-map/index.md)
- [Connecting infrastructure](https://docs.antigen.sh/docs/asset-map/connecting-infrastructure.md)
- [How teams use Asset Map](https://docs.antigen.sh/docs/asset-map/how-teams-use-asset-map.md)
- [How agents use Asset Map](https://docs.antigen.sh/docs/asset-map/how-agents-use-asset-map.md)
- [Overview](https://docs.antigen.sh/docs/runs/index.md)
- [tCell](https://docs.antigen.sh/docs/runs/tcell.md)
- [Targets](https://docs.antigen.sh/docs/runs/targets.md)
- [Vulnerabilities](https://docs.antigen.sh/docs/runs/vulnerabilities.md)
- [Evidence](https://docs.antigen.sh/docs/runs/evidence.md)
- [Reports](https://docs.antigen.sh/docs/runs/reports.md)
- [Overview](https://docs.antigen.sh/docs/vulnerability-lifecycle/index.md)
- [Hooks](https://docs.antigen.sh/docs/vulnerability-lifecycle/hooks.md)
- [How triage works](https://docs.antigen.sh/docs/vulnerability-lifecycle/how-triage-works.md)
- [How remediation works](https://docs.antigen.sh/docs/vulnerability-lifecycle/how-remediation-works.md)
- [Connecting your code](https://docs.antigen.sh/docs/vulnerability-lifecycle/connecting-your-code.md)
- [Assigning to your own agents](https://docs.antigen.sh/docs/vulnerability-lifecycle/assigning-to-your-own-agents.md)
- [Team workflows](https://docs.antigen.sh/docs/team-workflows/index.md)
- [Slack notifications](https://docs.antigen.sh/docs/team-workflows/slack.md)
- [Linear and GitHub Issues](https://docs.antigen.sh/docs/team-workflows/linear-github-issues.md)
- [SDK overview](https://docs.antigen.sh/docs/sdk/index.md)
- [Authentication](https://docs.antigen.sh/docs/sdk/authentication.md)
- [Agents](https://docs.antigen.sh/docs/sdk/agents.md)
- [Models](https://docs.antigen.sh/docs/sdk/models.md)
- [Skills](https://docs.antigen.sh/docs/sdk/skills.md)
- [Guardrails](https://docs.antigen.sh/docs/sdk/guardrails.md)
- [Runs](https://docs.antigen.sh/docs/sdk/runs.md)
- [Steering](https://docs.antigen.sh/docs/sdk/steering.md)
- [Stopping and resuming](https://docs.antigen.sh/docs/sdk/stopping-and-resuming.md)
- [Targets](https://docs.antigen.sh/docs/sdk/targets.md)
- [Vulnerabilities](https://docs.antigen.sh/docs/sdk/vulnerabilities.md)
- [Evidence](https://docs.antigen.sh/docs/sdk/evidence.md)
- [Full example](https://docs.antigen.sh/docs/sdk/full-example.md)
- [Overview](https://docs.antigen.sh/docs/cli/index.md)
- [Installation](https://docs.antigen.sh/docs/cli/installation.md)
- [Commands reference](https://docs.antigen.sh/docs/cli/commands.md)
- [CI/CD integration](https://docs.antigen.sh/docs/cli/ci-cd.md)
- [Integrations overview](https://docs.antigen.sh/docs/integrations/index.md)
- [AWS](https://docs.antigen.sh/docs/integrations/aws.md)
- [Vercel](https://docs.antigen.sh/docs/integrations/vercel.md)
- [Supabase](https://docs.antigen.sh/docs/integrations/supabase.md)
- [Railway](https://docs.antigen.sh/docs/integrations/railway.md)
- [Tailscale](https://docs.antigen.sh/docs/integrations/tailscale.md)
- [Okta](https://docs.antigen.sh/docs/integrations/okta.md)
- [Clerk](https://docs.antigen.sh/docs/integrations/clerk.md)
- [GitHub](https://docs.antigen.sh/docs/integrations/github.md)
- [Slack](https://docs.antigen.sh/docs/integrations/slack.md)
- [Linear](https://docs.antigen.sh/docs/integrations/linear.md)
- [Cursor Cloud](https://docs.antigen.sh/docs/integrations/cursor-cloud.md)
- [Devin](https://docs.antigen.sh/docs/integrations/devin.md)
- [Overview](https://docs.antigen.sh/docs/security/index.md)
- [Sandbox isolation](https://docs.antigen.sh/docs/security/sandbox-isolation.md)
- [Network security](https://docs.antigen.sh/docs/security/network-security.md)
- [Data handling](https://docs.antigen.sh/docs/security/data-handling.md)
- [Responsible use](https://docs.antigen.sh/docs/security/responsible-use.md)
- [Overview](https://docs.antigen.sh/docs/api/index.md)
- [Start device login](https://docs.antigen.sh/docs/api/endpoints/authentication/start-device-login.md): Start the CLI login flow and return a URL and code for browser approval.
- [Poll for a device access token](https://docs.antigen.sh/docs/api/endpoints/authentication/poll-for-a-device-access-token.md): Poll after the user approves the device login in their browser.
- [List API keys](https://docs.antigen.sh/docs/api/endpoints/api-keys/list-api-keys.md)
- [Create an API key](https://docs.antigen.sh/docs/api/endpoints/api-keys/create-an-api-key.md): The full API key is returned once and cannot be retrieved again.
- [Revoke an API key](https://docs.antigen.sh/docs/api/endpoints/api-keys/revoke-an-api-key.md)
- [List models](https://docs.antigen.sh/docs/api/endpoints/models/list-models.md)
- [List published agents](https://docs.antigen.sh/docs/api/endpoints/agents/list-published-agents.md)
- [Get an agent](https://docs.antigen.sh/docs/api/endpoints/agents/get-an-agent.md)
- [List targets](https://docs.antigen.sh/docs/api/endpoints/targets/list-targets.md)
- [Submit targets for approval](https://docs.antigen.sh/docs/api/endpoints/targets/submit-targets-for-approval.md)
- [Get a target](https://docs.antigen.sh/docs/api/endpoints/targets/get-a-target.md)
- [Remove a target](https://docs.antigen.sh/docs/api/endpoints/targets/remove-a-target.md)
- [List runs](https://docs.antigen.sh/docs/api/endpoints/runs/list-runs.md)
- [Create and start a run](https://docs.antigen.sh/docs/api/endpoints/runs/create-and-start-a-run.md)
- [Get a run](https://docs.antigen.sh/docs/api/endpoints/runs/get-a-run.md)
- [Stop a run immediately](https://docs.antigen.sh/docs/api/endpoints/runs/stop-a-run-immediately.md)
- [Stream run events](https://docs.antigen.sh/docs/api/endpoints/runs/stream-run-events.md)
- [Send a steering message](https://docs.antigen.sh/docs/api/endpoints/runs/send-a-steering-message.md)
- [Stop a run](https://docs.antigen.sh/docs/api/endpoints/runs/stop-a-run.md)
- [Resume a run](https://docs.antigen.sh/docs/api/endpoints/runs/resume-a-run.md)
- [List vulnerabilities](https://docs.antigen.sh/docs/api/endpoints/vulnerabilities/list-vulnerabilities.md)
- [Get a vulnerability](https://docs.antigen.sh/docs/api/endpoints/vulnerabilities/get-a-vulnerability.md)
- [Change vulnerability status](https://docs.antigen.sh/docs/api/endpoints/vulnerabilities/change-vulnerability-status.md): You cannot set the status to `verified`. Verification happens when an offensive agent retests a remediated vulnerability.
- [Change vulnerability assignee](https://docs.antigen.sh/docs/api/endpoints/vulnerabilities/change-vulnerability-assignee.md)
- [List evidence for a run](https://docs.antigen.sh/docs/api/endpoints/evidence/list-evidence-for-a-run.md)
- [List evidence for a vulnerability](https://docs.antigen.sh/docs/api/endpoints/evidence/list-evidence-for-a-vulnerability.md)
- [Download an evidence artifact](https://docs.antigen.sh/docs/api/endpoints/evidence/download-an-evidence-artifact.md)
- [Download a run report](https://docs.antigen.sh/docs/api/endpoints/reports/download-a-run-report.md)
- [List hooks](https://docs.antigen.sh/docs/api/endpoints/hooks/list-hooks.md)
- [Register a hook](https://docs.antigen.sh/docs/api/endpoints/hooks/register-a-hook.md)
- [Get a hook](https://docs.antigen.sh/docs/api/endpoints/hooks/get-a-hook.md)
- [Update a hook](https://docs.antigen.sh/docs/api/endpoints/hooks/update-a-hook.md)
- [Remove a hook](https://docs.antigen.sh/docs/api/endpoints/hooks/remove-a-hook.md)
- [List assets](https://docs.antigen.sh/docs/api/endpoints/asset-map/list-assets.md)
- [Get an asset](https://docs.antigen.sh/docs/api/endpoints/asset-map/get-an-asset.md)
- [Query the Asset Map](https://docs.antigen.sh/docs/api/endpoints/asset-map/query-the-asset-map.md)
- [Get Asset Map statistics](https://docs.antigen.sh/docs/api/endpoints/asset-map/get-asset-map-statistics.md)
- [List integrations](https://docs.antigen.sh/docs/api/endpoints/integrations/list-integrations.md)
- [Get an integration](https://docs.antigen.sh/docs/api/endpoints/integrations/get-an-integration.md)
- [Disconnect an integration](https://docs.antigen.sh/docs/api/endpoints/integrations/disconnect-an-integration.md)
- [Start an integration connection](https://docs.antigen.sh/docs/api/endpoints/integrations/start-an-integration-connection.md)
- [Home](https://docs.antigen.sh/docs/help/index.md): Find answers about your workspace, integrations, product guides, and policies—all in one place.
- [Getting started](https://docs.antigen.sh/docs/help/getting-started/index.md): Create your account, secure access, and connect the product to the tools your team already uses.
- [Quickstart: get set up in under 15 minutes](https://docs.antigen.sh/docs/help/getting-started/quickstart.md): A fast path from signup to first project: invites, roles, and your first integration.
- [Create your account](https://docs.antigen.sh/docs/help/getting-started/create-account.md): Sign up, verify your email, and choose the right organization type for your team.
- [Sign-in and security basics](https://docs.antigen.sh/docs/help/getting-started/sign-in-security.md): Passwords, SSO, session length, and how we protect your workspace.
- [Workspace: teams, roles, and settings](https://docs.antigen.sh/docs/help/getting-started/workspace/index.md): Configure how people collaborate: membership, roles, and org-wide preferences.
- [Invite teammates to your workspace](https://docs.antigen.sh/docs/help/getting-started/workspace/invite-teammates.md): Send invites, assign initial roles, and manage pending invitations.
- [Roles and permissions](https://docs.antigen.sh/docs/help/getting-started/workspace/roles-permissions.md): Understand what admins, members, and custom roles can see and change.
- [Organization settings](https://docs.antigen.sh/docs/help/getting-started/workspace/organization-settings.md): Name, branding touches, defaults, and workspace-level policies.
- [Billing and plans](https://docs.antigen.sh/docs/help/getting-started/billing/index.md): Plans, invoices, and upgrades for your workspace.
- [Compare plans](https://docs.antigen.sh/docs/help/getting-started/billing/compare-plans.md): Feature matrix across Free, Team, and Enterprise tiers for this demo help center.
- [Upgrade or downgrade your plan](https://docs.antigen.sh/docs/help/getting-started/billing/upgrade-downgrade.md): Change plans, proration, and limit changes for subscriptions.
- [Invoices and receipts](https://docs.antigen.sh/docs/help/getting-started/billing/invoices-receipts.md): Download invoices, update tax details, and reconcile charges.
- [Integrations overview](https://docs.antigen.sh/docs/help/getting-started/integrations/index.md): Connect Slack, CRMs, and custom tools using OAuth, webhooks, and partner connectors.
- [Connect Slack](https://docs.antigen.sh/docs/help/getting-started/integrations/connect-slack.md): Install the Slack app, pick channels, and manage notifications.
- [Connect your CRM](https://docs.antigen.sh/docs/help/getting-started/integrations/connect-crm.md): Link Salesforce or HubSpot through partner connectors or a custom sync strategy.
- [Developer integrations](https://docs.antigen.sh/docs/help/getting-started/integrations/developer/index.md): OAuth apps, webhooks, and API keys for building on the platform.
- [OAuth apps](https://docs.antigen.sh/docs/help/getting-started/integrations/developer/oauth-apps.md): Register an OAuth client, scopes, and redirect URLs for the API.
- [Webhooks](https://docs.antigen.sh/docs/help/getting-started/integrations/developer/webhooks.md): Subscribe to events, verify signatures, and retry safely.
- [API keys](https://docs.antigen.sh/docs/help/getting-started/integrations/developer/api-keys.md): Create, rotate, and scope API keys for server-side automation.
- [Partner connectors](https://docs.antigen.sh/docs/help/getting-started/integrations/partners/index.md): Packaged integrations for Salesforce, HubSpot, and custom connector templates.
- [Salesforce connector](https://docs.antigen.sh/docs/help/getting-started/integrations/partners/salesforce.md): Install, authenticate, and map Salesforce objects to the product.
- [HubSpot connector](https://docs.antigen.sh/docs/help/getting-started/integrations/partners/hubspot.md): Connect HubSpot CRM for deals and company records.
- [Custom connector template](https://docs.antigen.sh/docs/help/getting-started/integrations/partners/custom-connector-template.md): Fork the connector template to build a private integration faster.
- [Product guides](https://docs.antigen.sh/docs/help/product/index.md): Learn the interface, projects, editor, and automation features.
- [Interface overview](https://docs.antigen.sh/docs/help/product/interface-overview.md): Sidebar, command palette, and where to find settings.
- [Keyboard shortcuts](https://docs.antigen.sh/docs/help/product/keyboard-shortcuts.md): Speed up navigation and editing with keyboard shortcuts.
- [Search and navigation](https://docs.antigen.sh/docs/help/product/search-navigation.md): Find projects, pages, and automation using search.
- [Projects](https://docs.antigen.sh/docs/help/product/projects/index.md): Create projects, organize work, and archive when you are done.
- [Create a project](https://docs.antigen.sh/docs/help/product/projects/create-project.md): Name, visibility, and defaults when starting a new project.
- [Archive and restore projects](https://docs.antigen.sh/docs/help/product/projects/archive-restore.md): Archive completed work and restore when needed.
- [Editor and content](https://docs.antigen.sh/docs/help/product/editor/index.md): Drafts, publishing, comments, and version history in the editor.
- [Drafts and publishing](https://docs.antigen.sh/docs/help/product/editor/drafts-publishing.md): Draft states, review cues, and what happens when you publish.
- [Comments and mentions](https://docs.antigen.sh/docs/help/product/editor/comments-mentions.md): Threaded comments, @mentions, and notification controls.
- [Version history](https://docs.antigen.sh/docs/help/product/editor/version-history.md): Browse versions, compare changes, and restore content.
- [Automation](https://docs.antigen.sh/docs/help/product/automation/index.md): Rules, workflows, schedules, and advanced reliability patterns.
- [Rules and triggers](https://docs.antigen.sh/docs/help/product/automation/rules-triggers.md): Define when automation runs using events, filters, and guardrails.
- [Workflow builder](https://docs.antigen.sh/docs/help/product/automation/workflows/index.md): Build multi-step workflows with branches and error handling.
- [Build your first workflow](https://docs.antigen.sh/docs/help/product/automation/workflows/build-first-workflow.md): Step-by-step creation of a simple approval workflow.
- [Conditions and branches](https://docs.antigen.sh/docs/help/product/automation/workflows/conditions-branches.md): Model conditional paths and merge strategies in workflows.
- [Error handling](https://docs.antigen.sh/docs/help/product/automation/workflows/error-handling.md): Retries, compensating steps, and alerting when workflows fail.
- [Advanced patterns](https://docs.antigen.sh/docs/help/product/automation/advanced/index.md): Rate limits, idempotency, and retry policies for high-volume automation.
- [Rate limits](https://docs.antigen.sh/docs/help/product/automation/advanced/rate-limits.md): Understand automation rate limits and how to design around them.
- [Idempotency](https://docs.antigen.sh/docs/help/product/automation/advanced/idempotency.md): Use idempotency keys to make automation safe under retries.
- [Retry policies](https://docs.antigen.sh/docs/help/product/automation/advanced/retry-policies.md): Configure exponential backoff, max attempts, and dead-letter handling.
- [Scheduled tasks](https://docs.antigen.sh/docs/help/product/automation/scheduled-tasks.md): Cron-style schedules, timezone handling, and backoff.
- [Support and policies](https://docs.antigen.sh/docs/help/support/index.md): Get help, check status, troubleshoot, and review legal information.
- [Contact support](https://docs.antigen.sh/docs/help/support/contact-support.md): Channels, severity levels, and what to include in a support request.
- [Status and incidents](https://docs.antigen.sh/docs/help/support/status-incidents.md): Where to find live status and how incidents are communicated.
- [Troubleshooting](https://docs.antigen.sh/docs/help/support/troubleshooting/index.md): Fix common login and performance problems.
- [Login issues](https://docs.antigen.sh/docs/help/support/troubleshooting/login-issues.md): Resolve password resets, SSO failures, and session problems.
- [Performance issues](https://docs.antigen.sh/docs/help/support/troubleshooting/performance-issues.md): Diagnose slowness, large pages, and network constraints.
- [Account and data](https://docs.antigen.sh/docs/help/support/account-data/index.md): Export your data and understand account deletion.
- [Export your data](https://docs.antigen.sh/docs/help/support/account-data/export-data.md): Request exports, formats, and retention notes for your data.
- [Delete your account](https://docs.antigen.sh/docs/help/support/account-data/delete-account.md): Understand deletion impact and required confirmations.
- [Legal and compliance](https://docs.antigen.sh/docs/help/support/legal/index.md): Terms, privacy, regions, and compliance topics in this demo.
- [Terms of service](https://docs.antigen.sh/docs/help/support/legal/terms-of-service.md): Demo terms of service for this help center template.
- [Privacy and GDPR](https://docs.antigen.sh/docs/help/support/legal/privacy/index.md): Privacy policy, DPA, and subprocessors for this demo.
- [Privacy policy](https://docs.antigen.sh/docs/help/support/legal/privacy/privacy-policy.md): Demo privacy policy for this help center.
- [Data processing addendum](https://docs.antigen.sh/docs/help/support/legal/privacy/dpa.md): Demo DPA overview for controllers and processors.
- [Subprocessors](https://docs.antigen.sh/docs/help/support/legal/privacy/subprocessors.md): Illustrative list of subprocessors for this demo.
- [Regional specifics](https://docs.antigen.sh/docs/help/support/legal/regions/index.md): Data residency notes for EU, US, and APAC in this demo.
- [EU data residency](https://docs.antigen.sh/docs/help/support/legal/regions/eu-residency.md): EU data residency options in this demo help center.
- [US data residency](https://docs.antigen.sh/docs/help/support/legal/regions/us-residency.md): US data residency notes for this demo.
- [APAC](https://docs.antigen.sh/docs/help/support/legal/regions/apac.md): APAC considerations for this demo help center.

## OpenAPI Specs

- [openapi](https://docs.antigen.sh/docs/api/openapi.yaml)