Dynamiq
Apps

Invoke an app (proxy)

Proxies the request to the deployed app's own host, so you can run an app through the management API without resolving its hostname. The request body and response are **workflow-defined**: the body fields are the app workflow's Input-node fields (passthrough), and the response is whatever the app's Runs API endpoint returns. The route accepts any HTTP method; POST with a JSON body is the common case.

POST
/v1/apps/{app_id}/invoke

Authorization

AuthorizationBearer <token>

Organization or project Access Key created in the Dynamiq console. Used for deployed-app (Runs API), AI Gateway, traces collector, and management API requests. Send as Authorization: Bearer <access-key>.

In: header

Path Parameters

app_id*string

App UUID.

Request Body

application/json

Workflow-defined input fields (passthrough to the app's Input node). The exact fields depend on the deployed workflow.

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/v1/apps/497f6eca-6276-4993-bfeb-53cbbbba6f08/invoke" \  -H "Content-Type: application/json" \  -d '{    "input": {      "ticket_subject": "Charged twice for June invoice",      "ticket_body": "Hi, my card was charged twice this month. Order #4812."    }  }'
{
  "data": {
    "id": "8c2c8e2e-2f0a-4f4e-9f4f-6e1a52f0a001",
    "status": "completed",
    "output": {
      "category": "billing",
      "priority": "high"
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}
{
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}