Render a deployed presentation
POST /api/v1/projects/{projectId}/environments/{environmentId}/presentations/{definitionIdOrName}/renders
Render a presentation from the deployment the caller executes: the Agent Run's pinned or activation-bound Deployment for a process credential, otherwise the active Deployment. Every :query read runs in one read-only snapshot under the same owner, readable_by, soft-delete and access-policy scoping as a query operation. A read that exceeds the execution budget returns 422 with error.code execution_budget_exceeded and details.dimension, details.limit and details.observed. A render whose runtime storage is temporarily unavailable returns 503 with details.diagnostic.retryable true. A render that fails the runtime generation fence because the Environment was activated or moved is retried once against the refreshed Environment pointer; a second fence failure returns 409 with details.retryable true and details.conflictReason runtime_generation_changed or runtime_cutover_busy. A render is a read with no committed effect, so a client may resend it with the same requestKey; every attempt records its own presentation_render invocation.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Render a deployed presentation. |
environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to Render a deployed presentation. |
definitionIdOrName | one of 2 types | required | Identifies the definition element by its stable identifier or name. Applies to Render a deployed presentation. |
Request body
Required — Request body for: Render a deployed presentation.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
agentId | string | required | |
minPosition | string | optional | Opaque Environment change position. A generation change requires a new baseline. |
params | object | optional | |
actorUserId | string | optional | |
requestKey | string | optional |
Responses
| Status | Description | Body |
|---|---|---|
200 | Response for status 200 | application/json — object — data: object (required) |
400 | The request is malformed or cannot be processed. | application/json — PublicApiError — error: object (required) |
401 | Authentication failed. The Authorization header is missing, or the credential is invalid or expired. | application/json — PublicApiError — error: object (required) |
403 | Access denied. The authenticated user does not have permission to perform this action. | application/json — PublicApiError — error: object (required) |
404 | Resource not found. | application/json — PublicApiError — error: object (required) |
409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json — PublicApiError — error: object (required) |
422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json — PublicApiError — error: object (required) |
429 | Too many requests. | application/json — PublicApiError — error: object (required) |
500 | The server could not complete the request. | application/json — PublicApiError — error: object (required) |
503 | Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff. | application/json — PublicApiError — error: object (required) |