Skip to main content
  • Read: 7 min
  • Updated: August 17, 2026
  • Audience: Platform engineers and agent developers

When to use this prompt

Use this environment prompt when an agent, CI worker, or orchestration service must choose a source and start one Standard Apex scan without remaining attached for hours. The agent returns the workspace and scan identifiers plus links as soon as Apex accepts the scan. A person or separate worker can monitor it afterward. Do not combine it with CLI instructions. Apex CLI and MCP use device login; APEX_SERVICE_KEY authenticates only the REST API. Starting a scan requires scans:create. A later worker that polls status or downloads findings also needs scans:read or findings:read, respectively.
GET /api/apex/v1/credits returns the service key organization’s current standard, audit, and Lite balances plus effective scan-type availability. This is a point-in-time snapshot; scan creation remains authoritative if balances change before submission.
This prompt intentionally starts only standard scans. It offers an exact local archive or, when compatible, a provider-backed GitHub commit. It never offers audit or lite.

Copyable environment prompt

Why this returns immediately

  • The scan type is fixed to Standard, and the caller chooses and confirms the source before any upload or scan is created.
  • Source compatibility and the authenticated Standard balance snapshot filter the choices before the caller confirms one.
  • It returns stable workspace and scan identifiers plus clickable handoff links as soon as Apex accepts the scan.
  • Monitoring and findings retrieval are separate, resumable tasks, so the initiating agent does not remain attached for a multi-hour scan.
See the Apex service API guide for request examples, archive limits, scan-type constraints, status values, and retry behavior.