Validate and preview a debugger execution plan

POST/v1/debug-sessions/preview

How to call this endpoint

Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.

Path, query, and header parameters

These parameters control which ACP object the endpoint acts on and how the request is processed.

Path parameters
None.
Query parameters
None.

Body schema

Content type: application/json · Required

FieldTypeRequiredDescription
targetobjectYes
target.kindfunctionYes
target.resourceIdstringYes
scenarioIdfunction.http_requestYes
inputobjectYes
input.methodGET | POST | PUT | PATCH | DELETENo
input.pathstringNoWorkspace-relative file path.
input.bodyobjectNo
input.expectedRevisionstringNo
input.timeoutMsintegerNo

What the API returns

Each response code below includes the documented payload shape for the ACP API.

200Validated, redacted diagnostic execution previewapplication/json
FieldTypeRequiredDescription
schemaVersioncomputer_agents_diagnostic_v1Yes
targetobjectYes
target.kindfunction | web_app | connector | skillYes
target.resourceIdstringYes
target.resourceNamestringYes
scenarioobjectYes
scenario.idfunction.http_request | web_app.route_request | connector.connection_health | connector.runtime_access | connector.tool_call | skill.package_validation | skill.runtime_readinessYesUnique identifier.
scenario.titlestringYesDisplay title.
scenario.descriptionstringNoHuman-readable description.
scenario.inputSchemaobjectNo
scenario.stepsobject[]No
scenario.steps[].idstringYesUnique identifier.
scenario.steps[].titlestringYesDisplay title.
scenario.steps[].descriptionstringYesHuman-readable description.
scenario.steps[].statuspending | running | passed | failed | skippedYesCurrent lifecycle status.
scenario.steps[].durationMsintegerNo
scenario.steps[].summarystringNo
scenario.steps[].evidenceobjectNo
scenario.steps[].errorobjectNo
scenario.steps[].error.codestringNo
scenario.steps[].error.messagestringNoMessage text.
bindingobjectYes
binding.modedeployed_revisionYes
binding.revisionstringYes
requestobjectYes
stepsobject[]Yes
steps[].idstringYesUnique identifier.
steps[].titlestringYesDisplay title.
steps[].descriptionstringYesHuman-readable description.
steps[].statuspending | running | passed | failed | skippedYesCurrent lifecycle status.
steps[].durationMsintegerNo
steps[].summarystringNo
steps[].evidenceobjectNo
steps[].errorobjectNo
steps[].error.codestringNo
steps[].error.messagestringNoMessage text.
warningsstring[]Yes
redactedtrueYes
400Invalid target
None.
403Active organization or debugger permission required
None.
404Target resource not found
None.
502Connector runtime could not be reached
None.
503Connector diagnostics are not configured for this deployment
None.
Validate and preview a debugger execution plan
Loading...
Response 200
Loading...
See the ACP quickstart and SDK flow