Get an agent runtime deployment contract

GET/v1/agent-runtimes/{agentRuntimeId}

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
NameLocationTypeRequiredDescription
agentRuntimeIdpathstringYesAgent runtime ID
Query parameters
None.

Body schema

This endpoint does not require a request body.

None.

What the API returns

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

200Agent runtime details and invocation endpointsapplication/json
FieldTypeRequiredDescription
successbooleanNoWhether the request succeeded.
serverobjectNo
server.idstringNoUnique identifier.
server.userIdstringNoUser ID.
server.organizationIdstringNo
server.createdByUserIdstringNo
server.projectIdstringNoProject ID.
server.namestringNoHuman-readable name.
server.descriptionstringNoHuman-readable description.
server.kindwebsite | web_app | api | function | auth | agent_runtime | secrets | paymentsNo
server.sourceTypestringNo
server.sourceEnvironmentIdstringNo
server.sourcePathstringNoWorkspace-relative file path.
server.regionstringNo
server.runtimestringNo
server.authModepublic | privateNo
server.serviceUrlstringNo
server.customDomainstringNo
server.cloudRunServiceNamestringNo
server.imageUrlstringNo
server.statusdraft | deploying | deployed | failed | inactiveNoCurrent lifecycle status.
server.lastDeployedAtstringNo
server.metadataobjectNoFree-form metadata object.
server.createdAtstringNoISO 8601 timestamp.
server.updatedAtstringNoISO 8601 timestamp.
agentRuntimeobjectNo
agentRuntime.idstringNoUnique identifier.
agentRuntime.objectagent_runtimeNo
agentRuntime.namestringNoHuman-readable name.
agentRuntime.statusdraft | deploying | deployed | failed | inactiveNoCurrent lifecycle status.
agentRuntime.deployedbooleanNo
agentRuntime.protocolVersionstringNo
agentRuntime.endpointstringNo
agentRuntime.endpointsobjectNo
agentRuntime.agentIdstringNoAgent ID.
agentRuntime.environmentIdstringNoComputer ID.
agentRuntime.executionModesync | asyncNo
agentRuntime.streamingEnabledbooleanNo
agentRuntime.maxRuntimeSecondsintegerNo
agentRuntime.lastDeployedAtstringNo
decommissionedAtstringNo
Get an agent runtime deployment contract
Loading...
Response 200
Loading...
See the ACP quickstart and SDK flow