submit_record_step
/entities/{entity_id}/records/{record_id}/step/submitThrough an installed app, the returned panel carries the workflow's static names. Its form and values are cut to fields the app may read; opaque content and signed documents are omitted from this write response. Files a run produced answer 404.
A service principal's credential, or a person's access token, AgentFlow's own or an installed app's. A service principal's effective permissions are its role permissions intersected with the credential's scopes.
In: header
Path Parameters
Entity id
uuidRecord id
uuidHeader Parameters
A key of 1 to 255 printable ASCII characters. Repeating this request with the same key returns the original outcome instead of performing it again. A UUID is recommended.
1 <= length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/entities/497f6eca-6276-4993-bfeb-53cbbbba6f08/records/497f6eca-6276-4993-bfeb-53cbbbba6f08/step/submit" \ -H "Content-Type: application/json" \ -d '{ "payload": null }'{ "actions": [ { "edgeIds": [ "string" ], "icon": "string", "id": "string", "label": "string", "tone": null, "visibleWhen": null } ], "actions_gated_out": true, "assistant": null, "completion_mode": null, "content_not_shown": true, "context_graph_query_enabled": true, "context_handle": "string", "created_at": "2019-08-24T14:15:22Z", "draft_payload": null, "draft_saved_at": "2019-08-24T14:15:22Z", "entity_view": null, "export_form_id": "98ab7faa-14e3-406e-846c-e988fe264775", "form_definition": null, "form_definition_id": "b390c1bd-24be-4760-81d7-8c6a2d944ace", "invocations": [ { "attempt": 0, "budget_exceeded": true, "budget_tokens": 0, "budget_tool_calls": 0, "completed_at": "2019-08-24T14:15:22Z", "events": null, "failure_class": "string", "failure_detail": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "inlined_sources": null, "inputs": null, "iterations": 0, "max_iterations": 0, "max_tokens": 0, "messages": null, "model": "string", "model_display": "string", "parsed_output": null, "raw_output": "string", "reasoning": null, "rendered_prompt": "string", "started_at": "2019-08-24T14:15:22Z", "status": "string", "stop_reason": "string", "system_prompt": "string", "temperature": 0, "thinking": null, "tokens_input": 0, "tokens_output": 0, "tokens_reasoning": 0, "tool_call_count": 0, "tool_calls": null, "tools": null, "verbosity": "string" } ], "mentions": { "property1": { "href": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "kind": "user", "label": "string", "state": "ok" }, "property2": { "href": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "kind": "user", "label": "string", "state": "ok" } }, "org_timezone": "string", "prefill": null, "prefill_citations": null, "recent_events": [ null ], "review_documents": [ { "id": "string", "label": "string", "needs_signing": true } ], "review_readonly": true, "signed_action_id": "string", "signed_documents": [ { "byte_size": 0, "content_type": "string", "document_key": "string", "esign_request_id": "3050099e-34c1-45ff-a361-6274a90082cc", "filename": "string", "signed_at": "2019-08-24T14:15:22Z", "signed_attachment_id": "c26bd3ff-31eb-4e99-bbf5-0b1750dc77e5", "context_handle": "string" } ], "signing": null, "synthetic_form_marker": "string", "taken_action": null, "updated_at": "2019-08-24T14:15:22Z", "upstream_agent_confidence": 0, "viewer_access": "full", "entity_id": "8161163a-f227-466f-bc01-090a01e80165", "instance_name": "string", "kind": "human", "record_id": "8bf519b6-a3e0-49d2-8e42-039542d9a489", "run": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "step_key": "string", "step_label": "string", "workflow_id": "03e70e31-d7a4-4401-a629-6a4b6096cdfe", "workflow_name": "string" }, "signed": true, "signs": true, "step_status": "open", "subject": null}