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

List all agents

Request

Returns a list of agents associated with the account.

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

Responses

A list of agents

Bodyapplication/json
resultsArray of objects(Agent)required
results[].​idstringrequired
Example: "550e8400-e29b-41d4-a716-446655440000"
results[].​namestringrequired
Example: "Support Bot"
results[].​descriptionstring or nullrequired
Example: "Main customer support agent"
results[].​statusstringrequired
Enum"NONE""ACTIVE""INACTIVE""TRAINING""TRAIN_ERROR"
Example: "ACTIVE"
results[].​createdAtstringrequired
Example: "2024-01-01T12:00:00Z"
results[].​updatedAtstringrequired
Example: "2024-01-01T12:00:00Z"
Response
application/json
{
  "results": [
    { … }
  ]
}

Get agent analytics

Request

Returns credit usage and conversation counts for a specific agent.

Security
bearerAuth
Path
agentIdstringrequired
Example: uuid-xxxx-xxxx
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/agents/uuid-xxxx-xxxx/analytics?startDate=2024-01-01&endDate=2024-01-01' \
  -H 'Authorization: Bearer <YOUR_API Key_HERE>'

Responses

Agent analytics data

Bodyapplication/json
summaryobjectrequired
summary.​totalCreditsnumberrequired
Example: 500.25
summary.​totalConversationsnumberrequired
Example: 150
creditsByDateArray of objectsrequired
creditsByDate[].​datestringrequired
Example: "2024-01-01"
creditsByDate[].​totalCreditsnumberrequired
Example: 25.5
creditsByDate[].​conversationCountnumberrequired
Example: 10
Response
application/json
{
  "summary": {
    "totalCredits": 500.25,
    "totalConversations": 150
  },
  "creditsByDate": [
    { … }
  ]
}

Flows

Access flows associated with agents.

Operations

Workflows

Track and analyze account-wide workflows.

Operations