Developers

API reference

Internal pilot

Response fields

Read execution metadata without confusing service transport status with the upstream result.

Execution response

FieldMeaning
okWhether the provider response was successful.
statusThe upstream HTTP status.
bodyReturned content as a string.
contentTypeMedia type reported for the returned body.
formatRequested output format.
creditsReported provider charge, or null when not reported.
elapsedMsElapsed execution time in milliseconds.
bytesUTF-8 size of the returned body.
truncatedTrue when the upstream body exceeded the response bound.
requestIdIdentifier for this execution.

Check both status layers

The service can return a valid JSON envelope even when the upstream result has ok: false. Check the envelope’s status and ok; a successful HTTP transport alone does not prove the target returned usable content.

Handle the body by format

HTML is page markup, extended JSON contains provider page data, Markdown contains transformed text, and AI extraction returns provider-generated structured content. Validate the actual body before feeding it into an application.

Treat truncation explicitly

The service reads at most 2,000,000 upstream body bytes. If truncated is true, the body may be incomplete, including invalid JSON. Do not treat it as a complete document.

Dashboard preview

The dashboard HTML preview is static and sandboxed. Active scripts, navigation and external resources are removed or blocked. Use the code view or download the raw response when inspecting actual returned text.

Search documentation

Search guides, products and reference pages.