Skip to content

Apply Proposal POST

Overview

Applies a pending workflow proposal, executing the proposed changes to the workflow configuration.

Endpoint URL

POST /api/workflows/:workflowId/messages/apply

Endpoint Data

Parameter Description Type Required
workflowId The workflow's unique identifier (UUID) String Yes 
This endpoint has no query parameters.
Property Description Type Required
proposalId The proposal's unique identifier String (UUID) Yes
Example Body
{
  "proposalId": "550e8400-e29b-41d4-a716-446655440001"
}

Example Request

curl -X POST "http://localhost:3026/api/workflows/550e8400-e29b-41d4-a716-446655440000/messages/apply" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -b cookies.txt \
  --data '{
    "proposalId": "550e8400-e29b-41d4-a716-446655440001"
  }'

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": {
    "proposal": {
      "id": "550e8400-e29b-41d4-a716-446655440001",
      "status": "applied",
      "appliedAt": "2024-02-04T12:05:00.000Z"
    },
    "workflow": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Research Workflow",
      "steps": [
        {
          "id": "step-1",
          "toolId": "exa-web-search",
          "inputs": {}
        },
        {
          "id": "step-2",
          "toolId": "summarize",
          "inputs": {"text": "{{step-1.results}}"}
        }
      ],
      "updatedAt": "2024-02-04T12:05:00.000Z"
    }
  }
}

Response Fields

Field Type Description
proposal Object The applied proposal
proposal.id String (UUID) Proposal identifier
proposal.status String Now applied
proposal.appliedAt String ISO 8601 timestamp
workflow Object Updated workflow object

Error Responses

Status Code Error Description
400 Bad Request Invalid proposal ID or proposal not pending
401 Unauthorized Invalid or missing session
403 Forbidden Cannot access another user's workflow
404 Not Found Workflow or proposal does not exist