FruxonDocs
AgentsExecution

Executes an agent using its currently deployed revision.

Runs the agent synchronously and returns the complete result.

API-Only Endpoint

This endpoint is available via API only and requires authentication using the X-API-KEY header. Fill in your parameters below and the code samples will update automatically. To generate an API key, see the Settings guide.

Python SDK Available

You can also call this endpoint using the Fruxon Python SDK. Install with pip install fruxonFruxonClient.execute(), .execute_revision(), and .stream() cover this surface, and the fruxon run CLI wraps them with --stream / --no-stream / --revision.

POST
/v1/tenants/{tenant}/agents/{agent}:execute
X-API-KEY<token>

API key passed in the X-API-KEY header. Generate one from the Fruxon settings.

In: header

Path Parameters

agent*string

The unique identifier of the agent.

tenant*string

The tenant identifier

The execution parameters and inputs.

parameters?|null

A dictionary of input parameters for the agent execution. Keys correspond to parameter names defined in the agent's entry point flow step.

attachments?|null

A list of file attachments included with the execution request. These are files sent by the user (e.g., via a connector) that the agent can access during execution.

chatUser?
sessionId?string|null

An optional session ID for maintaining execution context across requests. When provided, the agent can resume a previous conversation session.

environmentSlug?string|null

Identifies the environment this execution targets. Enables per-environment cost tracking, quota enforcement, and analytics. For system agents, this is automatically set to the calling tenant's slug.

mode?string

Selects which integration-config variant an execution uses. Sandbox falls back to production per-config when no sandbox variant is configured. Callers normally send PRODUCTION or SANDBOX; UNSPECIFIED is the zero value and exists only so the field can be omitted on the wire without misrepresenting the user's intent — the host DTO supplies the real default (typically PRODUCTION).

Value in"UNSPECIFIED" | "PRODUCTION" | "SANDBOX"
[key: string]?never

Response Body

curl -X POST "https://api.fruxon.com/v1/tenants/string/agents/string:execute" \  -H "Content-Type: application/json" \  -d '{}'
{
  "response": "string",
  "trace": {
    "agentId": "string",
    "agentRevision": 0,
    "createdAt": 0,
    "parameters": {},
    "startTime": 0,
    "endTime": 0,
    "duration": 0,
    "traces": [
      {
        "id": "string",
        "displayName": "string",
        "type": "UNSPECIFIED",
        "llmStepTrace": null,
        "toolTrace": null,
        "hitlTrace": null,
        "steps": [],
        "result": null,
        "status": "UNSPECIFIED",
        "error": "string",
        "startTime": 0,
        "endTime": 0,
        "duration": 0
      }
    ],
    "result": {
      "strValue": "string",
      "jsonValue": null,
      "fileLink": "string"
    },
    "inputCost": 0,
    "outputCost": 0,
    "totalCost": 0
  },
  "sessionId": "string",
  "links": [
    {
      "fileId": "string",
      "fileType": "string",
      "promptLink": "<string:string/>"
    }
  ],
  "executionRecordId": "00000000-0000-0000-0000-000000000000",
  "status": "COMPLETED",
  "humanApprovalRequestId": "00000000-0000-0000-0000-000000000000"
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
Empty
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}