FruxonDocs
AgentsExecution

Executes an agent using its currently deployed revision with streaming output.

Returns results as Server-Sent Events (SSE) for real-time progress updates.

API-Only Endpoint

This endpoint is available via API only and requires a Fruxon bearer token: Authorization: Bearer YOUR_TOKEN. Fill in your parameters below and the code samples will update automatically. To generate a token, see the Settings guide.

Python SDK Available

You can also call this endpoint using the Fruxon Python SDK. Install with pip install fruxon — FruxonClient.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}:stream

Authorization

Token
AuthorizationBearer <token>

Fruxon token presented as a Bearer token: Authorization: Bearer fx_pat_… (personal) or fx_sat_… (service account). Generate one from Settings → API Access.

In: header

Path Parameters

agent*string

The unique identifier of the agent.

tenant*string

The tenant identifier

Request Body

The execution parameters and inputs.

parameters?

Key-value parameters to pass to the agent

attachments?

File attachments for the execution. Each entry references a file already uploaded through POST /storage; they are attached to the run's user turn, so a vision-capable model receives the images directly and every file stays addressable by its <fileType:fileId/> link. Maximum 20.

sessionId?string|null

Optional session ID for conversation continuity

mode?string

Integration-config variant this execution resolves against. Honoured on the draft-test endpoints; :execute / :stream run a deployed revision and always resolve Production configs, so the value is ignored there.

Value in"UNSPECIFIED" | "PRODUCTION" | "SANDBOX"
environmentSlug?string|null

Optional environment slug for per-end-customer cost tracking and analytics. Auto-creates the environment on first use (subject to the per-tenant environment cap).

Lengthlength <= 64
[key: string]?never

Response Body

curl -X POST "https://api.fruxon.com/v1/tenants/string/agents/string:stream" \  -H "Content-Type: application/json" \  -d '{}'
"string"
{
  "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
}

Executes an agent using its currently deployed revision.

Runs the agent synchronously and returns the complete result.

Gets per-environment execution summaries for an agent.

Returns aggregated execution count, total cost, and last activity time for each environment that has execution records for this agent. Pass `?include=trends` to also populate week-over-week deltas (current 7-day window vs. prior 7-day window).