Agent

Run Agent

Runs a single Floqer Nova web-agent request synchronously and returns the result. Provide a natural-language prompt and, optionally, an output_schema describing the JSON fields you want back. Requests typically take 10-60 seconds; the request stays open until the agent finishes. Billing: one Floqer Nova charge per request. Any 5xx response is automatically refunded — a 5xx means you were not charged. Every response (success or error) includes a request_id (e.g. fl_…) — quote it when contacting support. Error codes: INVALID_REQUEST, INVALID_OUTPUT_SCHEMA (400); UNAUTHORIZED (401); INSUFFICIENT_CREDITS (402); ROLE_FORBIDDEN, INSUFFICIENT_SCOPE (403); RATE_LIMITED (429); AGENT_INTERNAL_ERROR, AGENT_EXECUTION_FAILED (500); AGENT_BUSY (503); AGENT_TIMEOUT (504).

post/api/v1/agent/run

Request

  • Base URL
    http://localhost:3009
  • Auth
    HTTP bearer

Request body

promptstring required

Natural-language instruction for the web agent.

output_schemaobject

Optional JSON-schema-style object describing the structured output. Shape: { "properties": { "<field>": { "type": "string", "description": "..." } } }. Supported field types: string, number, integer, boolean, array, object. Max 20 fields. When omitted, the full answer is returned under a single result field.

Response

Agent completed successfully.

statusinteger
dataobject

Structured output keyed by your output_schema fields, or { result } when no schema given.

citationsobject[]

Web sources the agent consulted.

request_idstring

Unique id for this request (e.g. fl_…). Quote it when contacting support.

Changes

No recorded changes to this operation across all 1 revision of this API.