Error
A valid request URL is required to generate request examples{
"success": true,
"data": {
"changes": [
{
"field": "greeting",
"kind": "changed",
"before": "How can I help?",
"after": "Thanks for calling Peak Comfort HVAC — how can I help?"
},
{
"field": "languages",
"kind": "added",
"after": [
"en",
"es"
]
}
]
}
}{
"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
Compare a version with the draft
Returns the differences between a published version and the agent’s current draft, so you can review exactly what changed before publishing.
GET
/
agents
/
{id}
/
versions
/
{versionId}
/
diff
Error
A valid request URL is required to generate request examples{
"success": true,
"data": {
"changes": [
{
"field": "greeting",
"kind": "changed",
"before": "How can I help?",
"after": "Thanks for calling Peak Comfort HVAC — how can I help?"
},
{
"field": "languages",
"kind": "added",
"after": [
"en",
"es"
]
}
]
}
}{
"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).
The published version to compare the current draft against (id from listAgentVersions).