Quickstart

Documentation Index

Fetch the complete documentation index at: https://docs.testsprite.com/llms.txt

Use this file to discover all available pages before exploring further.

By the end of this guide you’ll have an API project that’s been discovered, planned, generated as Python tests, and executed against your live API, with full request/response capture for every call. No code on your side.

​

Step 1: Project Setup & PRD Upload

From the dashboard, click Create Tests. The first screen asks for two things only: a project name and your PRD (or any product-spec document — markdown, PDF, plain text all work).

​

Step 2: Feature & Use-Case Extraction

If you uploaded a PRD, TestSprite analyzes it and shows the Use Cases & Features screen with a flow graph of every feature it identified and the use cases under each. This feature map is what grounds plan generation downstream — test cases get scoped to the use cases here. Click Re-extract to redo the analysis on the same PRD (e.g. after editing the file). Otherwise continue.

​

Step 3: Choose Test Type and Configure

Pick the test type tab — Backend (APIs) for this API walkthrough — then provide your base URL, API documentation, auth type, and any extra testing instructions. Click Parse with AI at the bottom to start discovery. TestSprite reads your docs and confirms endpoint shapes against the live URL.

​

Step 4: Review Discovered Endpoints

Once discovery completes, you’ll see your endpoints grouped by resource family in an expandable table. For each row you can:

• Remove an endpoint — Click the × at the end of the row. Useful for internal-only endpoints, deprecated paths, or anything outside your test scope.
• Adjust the method or path — Click the row to edit if the inferred path template is wrong.
• Set the auth type per family — Use the Authentication Type dropdown. Choices: Basic, Bearer, API-key, None.

If discovery missed an endpoint, click Add Manually at the bottom of the page (or use the inline link under the upload card) to add it by hand. When you’re satisfied, continue to plan generation.

​

Step 5: Review and Adjust the Plan

TestSprite drafts a comprehensive plan organized by category — typically functional / happy path, authorization & auth, error handling & edge cases, and (where relevant) boundary / load and security probes. Categories are picked based on what each endpoint does. Untick any tests that don’t apply, tweak titles or descriptions in natural language, and click Generate Tests.

​

Step 6: Watch Tests Generate and Run

TestSprite generates a Python test per plan row, verifies each one before it lands in your suite, and executes them against your API. Tests stream into the project view as they finish. Each row surfaces one of: Pending, Running, Pass, Failed, Blocked. For multi-step workflows, TestSprite identifies which tests depend on each other and runs the chain in the right order — see Dependency Chains.

​

Step 7: Review and Refine

Click any test row to open its detail page. You get the request panel (exact HTTP call we made), response panel (what your API returned), error trace (where the assertion failed), and an AI cause-and-fix suggestion for failures. To iterate, use the Chat tab — describe what to fix in natural language. TestSprite either tweaks the assertions or regenerates the test. The run-level Test Report rolls up pass / fail / blocked counts with cause-and-fix highlights — share that link with the team.

​

Step 8: Cleanup Runs Automatically

After the run finishes, TestSprite removes the records your tests created (users, orders, sessions) so subsequent runs start fresh. The Cleanup tab shows what got deleted.

​

Step 9: Rerun and Schedule

To re-execute, use Rerun on a single test or Rerun all on the project toolbar. The Skip dependencies toggle in the rerun dialog lets you re-execute one test in isolation against cached upstream values — fast iteration when you’ve just refined an assertion.

​

Where to Go Next