Skip to content

Frontline Public API (1.0.0)

Public API for accessing agents, flows, and analytics.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License
Proprietary
Languages
Servers
Mock server
https://docs.getfrontline.ai/_mock/openapi
https://prod-api.getfrontline.ai

Agents

Manage and view AI agent data.

Operations

Flows

Access flows associated with agents.

Operations

List flows for an agent

Request

Returns a list of flows associated with a specific agent. Nodes and logic are excluded.

Security
bearerAuth
Path
agentIdstringrequired
Example: uuid-xxxx-xxxx
Query
statusstring
Enum"ACTIVE""SUSPENDED""DELETED""DRAFT"
Example: status=ACTIVE
curl -i -X GET \
  'https://docs.getfrontline.ai/_mock/openapi/public/v1/agents/uuid-xxxx-xxxx/flows?status=ACTIVE' \
  -H 'Authorization: Bearer <YOUR_API Key_HERE>'

Responses

A list of flows

Bodyapplication/json
resultsArray of objects(Flow)required
results[].​idnumberrequired
Example: 101
results[].​namestringrequired
Example: "Order Retrieval"
results[].​descriptionstring or nullrequired
Example: "Extracts order info from DB"
results[].​statusstringrequired
Enum"ACTIVE""SUSPENDED""DELETED""DRAFT"
Example: "ACTIVE"
results[].​createdAtstringrequired
Example: "2024-01-01T12:00:00Z"
results[].​updatedAtstringrequired
Example: "2024-01-01T12:00:00Z"
results[].​runCountnumberrequired
Example: 450
Response
application/json
{
  "results": [
    { … }
  ]
}

Workflows

Track and analyze account-wide workflows.

Operations