Skip to main content

Documentation Index

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

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

Starter projects are repositories Sapient can clone before running coding-agent API Performance evals. Use them when an eval should start inside a specific app, framework, SDK example, or integration fixture.

Commands

CommandDescription
sapient api-performance starter-projects listList starter projects.
sapient api-performance starter-projects createCreate a starter project.
sapient api-performance starter-projects retrieve --starter-project-id <starter_project_id>Retrieve one starter project.
sapient api-performance starter-projects update --starter-project-id <starter_project_id>Update one starter project.
sapient api-performance starter-projects delete --starter-project-id <starter_project_id>Delete one starter project.

List starter projects

sapient api-performance starter-projects list
Filter to one source:
sapient api-performance starter-projects list --integration-id int_123
Example response:
{
  "data": [
    {
      "id": "starter_123",
      "integration_id": "int_123",
      "name": "Next.js starter",
      "repo_url": "https://github.com/acme/api-starter",
      "ref": "main",
      "subdir": "",
      "install_steps": ["pnpm install"],
      "framework": "nextjs",
      "enabled": true
    }
  ],
  "meta": {
    "count": 1
  }
}

Create a starter project

sapient api-performance starter-projects create \
  --name "Next.js starter" \
  --repo-url "https://github.com/acme/api-starter" \
  --ref main \
  --framework nextjs \
  --install-steps "pnpm install"
Use --subdir when the app lives below the repository root:
sapient api-performance starter-projects create \
  --name "SDK examples" \
  --repo-url "https://github.com/acme/examples" \
  --subdir "examples/nextjs" \
  --framework nextjs
Supported framework values include fastify, nuxt, express, spa-js, angular, react, fastapi, vite, nextjs, and custom.

Retrieve a starter project

sapient api-performance starter-projects retrieve --starter-project-id starter_123

Update a starter project

sapient api-performance starter-projects update --starter-project-id starter_123 \
  --ref '"main"' \
  --enabled true
Updateable fields:
FlagDescription
--nameDisplay name.
--repo-urlGit repository URL.
--refBranch, tag, or commit SHA.
--subdirDirectory to use after cloning.
--install-stepsInstall commands. Use a repeated flag on create or a JSON array on update.
--integration-idSource ID this starter project applies to.
--frameworkFramework hint.
--enabledEnable or disable the starter project.

Delete a starter project

sapient api-performance starter-projects delete --starter-project-id starter_123