Error
A valid request URL is required to generate request examples{
"success": true,
"data": {
"willSay": [
"Business hours and location",
"Whether an address is in the service area"
],
"wontSay": [
"Pricing quotes"
],
"dataEgress": [
{
"skillName": "send_service_request",
"fields": [
"name",
"phone",
"address",
"problem"
],
"destination": "email:dispatch@peakcomforthvac.com"
}
],
"guardrails": [
{
"policyType": "no_medical_advice",
"description": "Never gives HVAC-adjacent health advice.",
"enabled": true
}
],
"knowledgeCoverage": 0.82,
"warnings": [
"No Spanish greeting set although Spanish is enabled."
],
"blockers": []
}
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Agents
Get the pre-publish report
Returns a plain-language summary of how the agent will behave once published, including what it can answer, what it will decline, and what information it discloses. Use it to review the agent before going live.
GET
/
agents
/
{id}
/
prepublish-report
Error
A valid request URL is required to generate request examples{
"success": true,
"data": {
"willSay": [
"Business hours and location",
"Whether an address is in the service area"
],
"wontSay": [
"Pricing quotes"
],
"dataEgress": [
{
"skillName": "send_service_request",
"fields": [
"name",
"phone",
"address",
"problem"
],
"destination": "email:dispatch@peakcomforthvac.com"
}
],
"guardrails": [
{
"policyType": "no_medical_advice",
"description": "Never gives HVAC-adjacent health advice.",
"enabled": true
}
],
"knowledgeCoverage": 0.82,
"warnings": [
"No Spanish greeting set although Spanish is enabled."
],
"blockers": []
}
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Authorizations
Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.
FlowClient Credentials
- Token URL
- /api/v1/api-keys
Scopes1
agents:read
Read agents.
Path Parameters
The agent's unique ID (the UUID returned by createAgent / listAgents).