# Octomind Docs

## Docs

- [Account settings](https://octomind.dev/docs/account/account-settings.md): How to set-up your personal & organization account
- [Projects](https://octomind.dev/docs/account/projects.md): All about projects
- [2-Factor Authentication](https://octomind.dev/docs/advanced/2fa.md): Logging in with a second factor
- [Basic authentication](https://octomind.dev/docs/advanced/basic-authentication.md): Logging in with basic authentication
- [Cross origin iframes](https://octomind.dev/docs/advanced/cross-origin-iframes.md): Disable browser cross-origin protections
- [File download](https://octomind.dev/docs/advanced/download.md): Adding a file download step
- [Email Flows](https://octomind.dev/docs/advanced/email-flows.md): Logging in or signing up with email
- [Execute custom JS](https://octomind.dev/docs/advanced/javascript-step.md): Execute custom JavaScript or TypeScript code during your test flow.
- [Octomind bot](https://octomind.dev/docs/advanced/octomind-bot.md): How Octomind navigates and crawls web pages in order to generate end-to-end tests
- [Rate limiting](https://octomind.dev/docs/advanced/rate-limiting.md): What is rate limiting and how to deal with it
- [Bug bounty program](https://octomind.dev/docs/advanced/security-policy.md): Policy for security flaws and bugs and bug bounty rewards
- [Teardown](https://octomind.dev/docs/advanced/teardown.md): Automatically clean up after your tests
- [File upload](https://octomind.dev/docs/advanced/upload.md): Adding a file upload step
- [Variables](https://octomind.dev/docs/advanced/variables.md): Customizable variables in tests
- [Waiting for a specific event](https://octomind.dev/docs/advanced/waiting.md): Waiting for a specific event to proceed and make the test more stable
- [Create a batch generation](https://octomind.dev/docs/api-reference/discoveries/create-a-batch-generation.md): Creates a batch generation for the given test target.
- [Create a discovery](https://octomind.dev/docs/api-reference/discoveries/create-a-discovery.md): Create a new test case discovery with a given name and prompt
- [Create an environment](https://octomind.dev/docs/api-reference/environments/create-an-environment.md): Create a custom environment.
- [Delete an environment](https://octomind.dev/docs/api-reference/environments/delete-an-environment.md): deletes an enviroment. this operation is not reversable.
- [Retrieve environments](https://octomind.dev/docs/api-reference/environments/retrieve-environments.md): get a list of all defined environments.
- [Update an environment](https://octomind.dev/docs/api-reference/environments/update-an-environment.md): Updates an enviroment, all properties can be set separately
- [Execute tests of the given test target](https://octomind.dev/docs/api-reference/execute/execute-tests-of-the-given-test-target.md): This endpoint triggers a test execution by sending an test target id, an URL and optionally tags, an environment and variables.
- [Retrieve notifications](https://octomind.dev/docs/api-reference/notifications/retrieve-notifications.md): Get a list of notifications for a specific test target.
- [Register a private location](https://octomind.dev/docs/api-reference/private-locations/register-a-private-location.md): registers a private location worker
- [Retrieve all private locations](https://octomind.dev/docs/api-reference/private-locations/retrieve-all-private-locations.md): gets a list of private location workers
- [Unregister a private location](https://octomind.dev/docs/api-reference/private-locations/unregister-a-private-location.md): Unregisters a private location worker.
- [Retrieve information about a test report](https://octomind.dev/docs/api-reference/reports/retrieve-information-about-a-test-report.md): Poll from within a CI-pipeline to wait for the completion of a report.
- [Retrieve paginated information about test reports](https://octomind.dev/docs/api-reference/reports/retrieve-paginated-information-about-test-reports.md): Allow fetching the history of test reports for your test target.
- [Delete a test case](https://octomind.dev/docs/api-reference/test-cases/delete-a-test-case.md): Delete a specific test case
- [List test cases](https://octomind.dev/docs/api-reference/test-cases/list-test-cases.md): Get a list of test cases for a specific test target with optional filtering
- [Retrieve a specific test case version](https://octomind.dev/docs/api-reference/test-cases/retrieve-a-specific-test-case-version.md): Get detailed information about a specific version of a test case, including its local editing status.
- [Retrieve a test case](https://octomind.dev/docs/api-reference/test-cases/retrieve-a-test-case.md): Get detailed information about a specific test case
- [Retrieve code for a test case](https://octomind.dev/docs/api-reference/test-cases/retrieve-code-for-a-test-case.md): Get the code representation of a specific test case
- [Update a test case](https://octomind.dev/docs/api-reference/test-cases/update-a-test-case.md): Update specific properties of a test case
- [Update a test case element](https://octomind.dev/docs/api-reference/test-cases/update-a-test-case-element.md): Update a the locator line of a specific test case element
- [Explore a test plan](https://octomind.dev/docs/api-reference/test-plans/explore-a-test-plan.md): This endpoint triggers exploration of test cases from a test plan against a specific URL (e.g., PR deployment).   It finds the newest matching test plan for the given context, then starts discovery for each test case in the plan.
- [Get test plan by ID](https://octomind.dev/docs/api-reference/test-plans/get-test-plan-by-id.md): Retrieve a test plan by its unique identifier
- [Create a new test target](https://octomind.dev/docs/api-reference/test-targets/create-a-new-test-target.md): Creates a new test target.
- [Delete a test target](https://octomind.dev/docs/api-reference/test-targets/delete-a-test-target.md): Deletes a test target by ID.
- [Get TestSuite code](https://octomind.dev/docs/api-reference/test-targets/get-testsuite-code.md): Retrieve the typescript code in a zip file for a set of yaml based test cases. This code can then be executed by playwright.
- [Pull all test case from a test target to use it locally as json or yaml and work with the files directly. There is also a "opposite" endpoint to push the files back to the test target.](https://octomind.dev/docs/api-reference/test-targets/pull-all-test-case-from-a-test-target-to-use-it-locally-as-json-or-yaml-and-work-with-the-files-directly-there-is-also-a-"opposite"-endpoint-to-push-the-files-back-to-the-test-target.md): Get the pull data for a specific test target
- [Push draft test target](https://octomind.dev/docs/api-reference/test-targets/push-draft-test-target.md): Push all test cases from a local representation to a test target as a draft.
- [Push test target](https://octomind.dev/docs/api-reference/test-targets/push-test-target.md): Pushes all test cases with the specified schema to the test target. There is also a "opposite" endpoint to pull the files back to the local machine.
- [Retrieve a test target](https://octomind.dev/docs/api-reference/test-targets/retrieve-a-test-target.md): Gets a test target by ID.
- [Retrieve all test targets](https://octomind.dev/docs/api-reference/test-targets/retrieve-all-test-targets.md): Gets a list of test targets.
- [Retrieve test target configuration](https://octomind.dev/docs/api-reference/test-targets/retrieve-test-target-configuration.md): Get the test target configuration for a specific environment
- [Update a test target](https://octomind.dev/docs/api-reference/test-targets/update-a-test-target.md): Updates a test target by ID.
- [Use your AI via MCP](https://octomind.dev/docs/build-tests/create-via-mcp.md): Use your own AI tools connected to data sources to create Octomind tests
- [Import tests](https://octomind.dev/docs/build-tests/import-tests.md): Use native TestRail integration or MCP to import tests from test management systems
- [Prompt AI Agent](https://octomind.dev/docs/build-tests/prompt-agent.md): Use natural language to prompt our AI agent to generate new tests
- [Recommended tests](https://octomind.dev/docs/build-tests/recommended-tests.md): Our AI agent will automatically suggest relevant test cases to increase your coverage.
- [Record tests](https://octomind.dev/docs/build-tests/recorder.md): A brand new test Recorder that collaborates with the AI Agent or works on its own
- [Test setup](https://octomind.dev/docs/build-tests/test-setup.md): A checklist to setup your test suite quickly.
- [Feature drops](https://octomind.dev/docs/changelog/changelog.md): All the nice stuff you asked for
- [Commands](https://octomind.dev/docs/cli/commands.md): How to use the CLI tool
- [CLI tool](https://octomind.dev/docs/cli/installation.md): How to use & install the octomind CLI tool
- [Need an NDA?](https://octomind.dev/docs/data-governance/nda.md): Here is a template for a non-disclosure agreement if you need one.
- [Compliance and security](https://octomind.dev/docs/data-governance/no-code-access.md): All about Octomind data access and governance
- [Dev Mode Commands](https://octomind.dev/docs/dev-mode/commands.md): Detailed guide to CLI commands for working with tests as code
- [Overview](https://octomind.dev/docs/dev-mode/dev-mode.md)
- [Chat with AI](https://octomind.dev/docs/get-started/chat-with-ai.md): Chat with our AI agent to learn more about Octomind and get help in completing tasks
- [Create first tests](https://octomind.dev/docs/get-started/create-first-tests.md): Generate your first tests and run them. Find bugs in your app before your users do.
- [Edit a test case](https://octomind.dev/docs/get-started/edit-tests.md): Use manual editing, the Recorder or the Agent to edit test steps
- [Execute your tests](https://octomind.dev/docs/get-started/execute-tests.md): Run your tests to find bugs in your app. We will help you figure out what went wrong.
- [Why the AI agent fails](https://octomind.dev/docs/guides/agent-fails.md): Why does the AI agent fail to to generate a test case?
- [Help the Agent generate](https://octomind.dev/docs/guides/help-agent-succeed.md): Finetune a generated test together with the Agent
- [Long running background tasks](https://octomind.dev/docs/guides/long-running.md): Test orchestration of flows with long running parts outside of the app
- [Short vs. long tests](https://octomind.dev/docs/guides/long-vs-short.md): Which one is better? How should I structure my test suite?
- [Projects or environments?](https://octomind.dev/docs/guides/project-environments.md): Best practices for using Octomind
- [Prompt debugging](https://octomind.dev/docs/guides/prompt-debugging.md): How to fix prompts causing problems in Octomind tests
- [Slow loading elements](https://octomind.dev/docs/guides/slow-loading.md): Managing timeouts and handling slow-Loading elements
- [Best practices for generating tests](https://octomind.dev/docs/guides/test-creation-best-practices.md): How to nail creating new tests for your project
- [Test steps debugging deepdive](https://octomind.dev/docs/guides/test-steps-debugging.md): How to fix test steps with Octomind's visual editor
- [Mutli-digit codes](https://octomind.dev/docs/guides/typing-multidig.md): Typing multi-digit codes into OTP fields
- [Integrate GitHub (New Flow)](https://octomind.dev/docs/integrations/github-new-flow.md): Install the Octomind GitHub App from inside the Octomind settings modal and enable TestPlan-based exploration on pull requests
- [Run Tests in CI](https://octomind.dev/docs/integrations/integrations-overview.md): Trigger tests from your CI pipeline and get results commented back
- [Allure integration](https://octomind.dev/docs/integrations/other/allure-integration.md): How to integrate with Allure
- [Batch Generation GitHub Action](https://octomind.dev/docs/integrations/other/batch-generation.md): Create e2e tests without leaving your dev workflow - generate them from your CI pipeline automatically
- [Testrail integration](https://octomind.dev/docs/integrations/other/test-management.md): How to integrate with TestRail
- [XRay integration](https://octomind.dev/docs/integrations/other/xray-integration.md): How to integrate with Xray
- [Zephyr integration](https://octomind.dev/docs/integrations/other/zephyr-integration.md): How to integrate with Zephyr
- [Integrate with Azure DevOps](https://octomind.dev/docs/integrations/quickstart-Azure.md): Run an Azure DevOps task to get Octomind test results into your pull request comments
- [Integrate with GitHub Actions](https://octomind.dev/docs/integrations/quickstart-GitHub.md): Run a GitHub Action to get Octomind test results into your pull request comments
- [Integrate with Jenkins](https://octomind.dev/docs/integrations/quickstart-Jenkins.md): Trigger Octomind in your Jenkins pipeline via GitHub webhook
- [Integrate with other CI pipelines](https://octomind.dev/docs/integrations/quickstart-Other.md): Trigger Octomind in your pipeline via cURL
- [Integrate with Vercel CI](https://octomind.dev/docs/integrations/quickstart-Vercel.md): Run a GitHub Action to execute Octomind tests on Vercel deployment
- [AI auto-fix (beta)](https://octomind.dev/docs/maintain-tests/auto-fix.md): Automatically repair broken tests with the power of AI..
- [Inspect broken tests](https://octomind.dev/docs/maintain-tests/inspect-broken-tests.md): Identify the cause of a broken test easily
- [Why tests fail](https://octomind.dev/docs/maintain-tests/why-tests-fail.md): What are the reasons for a red test?
- [Environments](https://octomind.dev/docs/manage-tests/environments.md): Use of test environments in Octomind
- [Test cases](https://octomind.dev/docs/manage-tests/test-cases.md): This is where all your tests live
- [Test reports](https://octomind.dev/docs/manage-tests/test-reports.md): Test reports sum up the results of a test run - a single execution of all your active test cases.
- [Using a hosted Octomind MCP server](https://octomind.dev/docs/mcp/hosted-mcp.md): Learn how to use a hosted Octomind MCP server
- [Install the Octomind MCP server](https://octomind.dev/docs/mcp/install-octomind-mcp.md): Learn everything about the Octomind Model Context Protocol (MCP) server
- [FAQs](https://octomind.dev/docs/more-info/faq.md): Frequently asked questions
- [Octo Dictionary](https://octomind.dev/docs/more-info/octo-dictionary.md): Essential terminology used within the Octomind app
- [Storage](https://octomind.dev/docs/more-info/storage.md): Store your data in preferred regional storage
- [Under the hood](https://octomind.dev/docs/more-info/under-the-hood.md): If you are interested in how we make the tests work, this is your place.
- [Private location worker](https://octomind.dev/docs/proxy/private-location.md): How to access applications that are not publicly available
- [Proxy settings](https://octomind.dev/docs/proxy/proxy-settings.md): How to access from different geo's or a private location
- [Run tests in CI/CD](https://octomind.dev/docs/run-tests/execution-CI.md): Trigger tests from your CI pipeline and get results commented back
- [Execute via shell script](https://octomind.dev/docs/run-tests/execution-curl.md): Trigger test execution from outside our app with a cURL command
- [Run tests locally](https://octomind.dev/docs/run-tests/execution-local.md): Run your tests locally against your development environment
- [Schedule test runs](https://octomind.dev/docs/run-tests/execution-scheduled.md): Run your tests and get test results in regular intervals
- [Custom headers](https://octomind.dev/docs/runtime/custom-headers.md): Additional HTTP headers to be sent with every request
- [Test ID attribute](https://octomind.dev/docs/runtime/testid-attribute.md): Configure the html attribute name you use for test automation

## OpenAPI Specs

- [openapi](https://octomind.dev/docs/api-ref/openapi.yaml)
- [pnpm-lock](https://octomind.dev/docs/pnpm-lock.yaml)
- [package](https://octomind.dev/docs/package.json)
- [package-lock](https://octomind.dev/docs/package-lock.json)
- [settings](https://octomind.dev/docs/.vscode/settings.json)