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

Workflows

Track and analyze account-wide workflows.

Operations

List all workflows

Request

Returns a list of workflows associated with the account. Nodes and logic are excluded.

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

Responses

A list of workflows

Bodyapplication/json
resultsArray of objects(Workflow)required
results[].​idnumberrequired
Example: 501
results[].​namestringrequired
Example: "Daily CRM Sync"
results[].​descriptionstring or nullrequired
Example: "Syncs contacts to HubSpot"
results[].​statusstringrequired
Enum"ACTIVE""DELETED""DRAFT"
Example: "ACTIVE"
results[].​triggerTypestring or nullrequired
Enum"CONVERSATION_ENDED""CONTACT_CREATED""CONTACT_UPDATED""FEEDBACK_CAPTURED""INCOMING_WEBHOOK""TABLE_ROW_CREATED""SCHEDULED_TRIGGER""CONVERSATION_IDLE"
Example: "CONVERSATION_ENDED"
results[].​createdAtstringrequired
Example: "2024-01-01T12:00:00Z"
results[].​updatedAtstringrequired
Example: "2024-01-01T12:00:00Z"
results[].​runsCountnumberrequired
Example: 1200
results[].​runsFailedCountnumberrequired
Example: 5
results[].​lastRunDatestring or nullrequired
Example: "2024-01-01T12:00:00Z"
Response
application/json
{
  "results": [
    { … }
  ]
}

Get workflow analytics

Request

Returns analytics for a specific workflow, including runs by date and summary.

Security
bearerAuth
Path
workflowIdnumber or null
Example: 42
Query
startDatestring or null
Example: startDate=2024-01-01
endDatestring or null
Example: endDate=2024-01-01
curl -i -X GET \
  'https://docs.getfrontline.ai/_mock/openapi/public/v1/workflows/42/analytics?startDate=2024-01-01&endDate=2024-01-01' \
  -H 'Authorization: Bearer <YOUR_API Key_HERE>'

Responses

Workflow analytics data

Bodyapplication/json
runsByDateArray of objectsrequired
runsByDate[].​datestring or nullrequired
Example: "2024-01-01"
runsByDate[].​totalRunsnumberrequired
Example: 100
runsByDate[].​completedRunsnumberrequired
Example: 95
runsByDate[].​failedRunsnumberrequired
Example: 5
runsByDate[].​pendingRunsnumberrequired
Example: 0
runsByDate[].​totalCreditsnumberrequired
Example: 250.5
summaryobjectrequired
summary.​totalRunsnumberrequired
Example: 1000
summary.​completedRunsnumberrequired
Example: 950
summary.​failedRunsnumberrequired
Example: 50
summary.​pendingRunsnumberrequired
Example: 0
summary.​totalCreditsnumberrequired
Example: 2500
summary.​averageCreditsPerRunnumberrequired
Example: 2.5
summary.​nonExecutedRunsnumberrequired
Example: 10
Response
application/json
{
  "runsByDate": [
    { … }
  ],
  "summary": {
    "totalRuns": 1000,
    "completedRuns": 950,
    "failedRuns": 50,
    "pendingRuns": 0,
    "totalCredits": 2500,
    "averageCreditsPerRun": 2.5,
    "nonExecutedRuns": 10
  }
}