Error
A valid request URL is required to generate request examplesevent: progress
data: {"step":"crawling","label":"Reading your website…","progress":{"current":3,"total":12}}
event: progress
data: {"step":"persona","label":"Drafting the persona…"}
event: done
data: {"step":"done","label":"Draft ready","message":"agt_4f9c2b7e10a24d51"}
{
"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>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Agents
Scaffold a draft agent
Generates a draft agent automatically from a website URL, a written procedure, or a plain-language description. Streams progress while it builds and returns the finished draft agent at the end of the stream. Review and publish the draft before it goes live.
POST
/
agents
/
scaffold
Error
A valid request URL is required to generate request examplesevent: progress
data: {"step":"crawling","label":"Reading your website…","progress":{"current":3,"total":12}}
event: progress
data: {"step":"persona","label":"Drafting the persona…"}
event: done
data: {"step":"done","label":"Draft ready","message":"agt_4f9c2b7e10a24d51"}
{
"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>"
}
]
}{
"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:write
Create/update/delete agents, publish, rollback.
Body
application/json
Which source populates the draft, and which field carries it: url → crawl the site at url; sop → read the uploaded document at file_id; describe → use the free-text brief in text.
Available options:
url, sop, describe Website to crawl (required when input_type=url).
Uploaded SOP/document id from Uploads (required when input_type=sop).
Plain-language description of the business (required when input_type=describe).
Optional industry hint (e.g. "hvac", "dental") to bias persona and skills.