FruxonDocs
AgentsCore

Lists all agents the current user has access to.

Tenant admins receive every agent in the tenant; other users receive only the agents on which they have an explicit collaborator role (Viewer, Editor, or Admin). The response is cursor-paginated, newest-first, and includes soft-deleted agents only while they are still within the deletion grace period. Use this to populate agent pickers; for per-agent detail, follow up with `GET /v1/tenants/{tenant}/agents/{agent}`.

GET
/v1/tenants/{tenant}/agents

Authorization

Bearer
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

tenant*string

The tenant identifier

Query Parameters

PageSize?integer

The maximum number of items to return per page

Formatint32
PageToken.Skip?integer
Formatint32
PageToken.Cursor?string

Opaque cursor token from an external system (e.g. RAG API). When set, M:Fruxon.Common.Collections.PageToken.AsString returns this value directly instead of encoding Fruxon.Common.Collections.PageToken.Skip.

search?string

Optional case-insensitive substring filter (search query parameter) matched against the agent id, display name, and description. Omit for the unfiltered list.

tags?array<string>

Optional tag filter (tags query parameter, repeatable). Agents carrying any of the supplied tags match. Use GET .../agents/facets to discover the available tags.

shape?string

Optional flow-shape filter (shape query parameter, e.g. WORKFLOW). Narrows to agents whose current deployed revision has that structural Fruxon.Model.Agents.FlowShape. Omit for all shapes.

Value in"UNSPECIFIED" | "AGENT" | "WORKFLOW" | "TOOL_ONLY" | "EMPTY" | "INVALID"
runnableType?string

Optional runnable-type filter (runnableType query parameter, e.g. AGENT or WORKFLOW). Narrows to agents declared as that Fruxon.Model.Agents.RunnableType product type. Omit for all types.

Value in"UNSPECIFIED" | "AGENT" | "WORKFLOW"

Response Body

curl -X GET "https://api.fruxon.com/v1/tenants/string/agents"
{
  "items": [
    {
      "id": "string",
      "displayName": "string",
      "description": "string",
      "avatarFileId": "string",
      "tags": [
        "string"
      ],
      "type": "SUMMARIZATION",
      "enabled": false,
      "currentRevision": 0,
      "shape": "AGENT",
      "runnableType": "AGENT",
      "createdAt": 0,
      "modifiedAt": 0,
      "tenantId": "00000000-0000-0000-0000-000000000000",
      "solutionId": "string",
      "deletedAt": 0,
      "evaluationMetrics": [],
      "origin": "NATIVE",
      "externalConfig": {
        "parameters": {}
      },
      "redactLlmMessages": false
    }
  ],
  "nextPageToken": "string",
  "totalCount": 0
}
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
}

Activates an agent

Flips the agent's `Enabled` flag to true so connectors and scheduled triggers will route executions to it. The agent must already have a deployed revision; activation alone does not build or deploy flow content. Idempotent — calling it on an already-enabled agent simply returns the current state. Pair with `POST /v1/tenants/{tenant}/agents/{agent}:deactivate` to pause traffic without deleting.

Cancels a pending agent deletion within the grace period

Restores an agent that was soft-deleted via `DELETE /v1/tenants/{tenant}/agents/{agent}` but has not yet been purged. The agent reappears in list/get responses with its previous configuration and collaborators intact. Returns 400 if the agent is not currently in a pending-delete state, and 404 if the grace period has already expired and the agent was purged.