> For the complete documentation index, see [llms.txt](https://docs.ixhello.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ixhello.com/ixhc2/integrations/executing-flow-via-api-headless-execution.md).
# Executing Flow via API (Headless Execution)
Agentic flows are typically triggered by a webchat, channel integration, or another UI surface. Sometimes, you may need to run a flow programmatically — for example, to:
* Integrate the flow into a custom application or backend process.
* Trigger automation without a user interface (headless execution).
* Run tests or batch processes against a flow.
This API endpoint lets you directly execute an existing flow without requiring a connected front end.
When you execute a flow this way, it runs exactly as if a user had triggered it through a channel. The flow can take input variables, process logic, and — if configured — call external services to store results.
## Making the Request
### Endpoint
```
POST /cgw/process/v1/orgs//flows//execute
```
### Example Request
```
curl --location '/cgw/process/v1/orgs//flows//execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ' \
--data '{
"": "",
"": ""
}'
```
### Parameters
| Variable | Description |
| ------------- | ----------------------------------------------------------------------------------------- |
| BASE\_URL | URL of the API Gateway hosting your instance |
| ORG\_ID | The organization ID that contains the flow you want to execute |
| FLOW\_ID | The ID of the flow you want to run |
| BEARER\_TOKEN | Authentication token needed for API access |
| Request Body | Optional JSON key-value pairs representing variables your flow expects (multiple allowed) |
{% hint style="info" %}
BASE\_URL, ORG\_ID, FLOW\_ID, and BEARER\_TOKEN will be provided by your Product Support Team.
{% endhint %}
## Responses
| HTTP Status Codes | Description |
| ------------------------- | -------------------------------------------------- |
| 200 OK | Flow executed successfully |
| 400 Bad Request | Invalid request body or missing required variables |
| 401 Unauthorized | Invalid or missing bearer token |
| 404 Not Found | ORG\_ID or FLOW\_ID not found |
| 500 Internal Server Error | Unexpected issue during execution |
### Example — Success
```
{
"sessionId": "6e16376b-fd09-4a9a-a49a-9ba4c3901563",
"result": "Execution completed"
}
```
### Example — Failure
```
{
"error": "Failed to execute flow 8c996034-eeff-4efc-b04e-4fb410d6f2b"
}
```
If your flow needs to return data, it must include a step (such as a REST call) to push results to your system. This endpoint itself only reports execution status.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://docs.ixhello.com/ixhc2/integrations/executing-flow-via-api-headless-execution.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.