Push New Action to Transcription Request

Endpoint Overview

Endpoint:
POST /api/companies/{companyCuid}/orchestrators/{orchestratorCuid}/transcriptionRequests/{processCuid}/action

This endpoint allows you to dynamically push a new action to an existing transcription process. Actions are appended to the process pipeline and executed sequentially.

Once pushed, the new action will be associated with the process. To monitor its status and retrieve the result, use the Get transcription results endpoint.

---

Path Parameters

Parameter	Description	Type	Required	Example
companyCuid	Unique identifier of the company	String	Yes	cmp_abc123
orchestratorCuid	Unique identifier of the orchestrator	String	Yes	orc_def456
processCuid	Unique identifier of the transcription job	String	Yes	proc_789ghi

---

Request Body

Field	Description	Type	Required	Example
action_type	Type of action to perform (e.g. factual_summary)	String	Yes	"factual_summary"
webhook	Webhook to call with the result when the action finishes	String	No	"https://example.com/my/webhook"
external_metadata	Optional metadata (conversation ID, source, etc.)	Object	No	{ "conversation_id": "xyz", "source": "ui" }

Example

{
  "action_type": "factual_summary",
  "webhook": "https://example.com/my/webhook",
  "external_metadata": {
    "conversation_id": "xyz-1234",
    "source": "user-interface"
  }
}

Response

On success, the server returns the newly added action as part of the response.

Field	Description	Type
action_type	Type of the action added	String
status	Initial status of the action (pending)	String
created_at	Timestamp when the action was created	DateTime
webhook	Webhook URL provided for this action	String
external_metadata	External metadata passed in the request	Object

Example Response

{
  "action_type": "factual_summary",
  "status": "pending",
  "created_at": "2025-04-04T10:15:00Z",
  "webhook": "https://example.com/my/webhook",
  "external_metadata": {
    "conversation_id": "xyz-1234",
    "source": "user-interface"
  }
}