ANanyreach
http-steps

Preview Http Step

Run a single HTTP step against a provided context (no workflow execution).

Sync handler so the blocking requests call runs in FastAPI's thread pool instead of blocking the asyncio event loop.

post/workflow/http-steps/preview

Request

  • Base URL
    https://api.anyreach.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Headers

x-anyreach-orgstring nullable

Organization ID for user PATs (pat_ prefix tokens)

Request body

method'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS'
urlstring
headersobject
query_paramsobject
body_type'json' | 'form' | 'raw'
compress'none' | 'gzip' | 'gzip_payload'

Whether the request body is gzipped, and whether that is declared.

The two gzip modes are not a style choice. GZIP is the HTTP-correct one: the body is a compressed representation of the payload and Content-Encoding: gzip tells the server to decompress it before handing it to the application.

GZIP_PAYLOAD sends the same bytes and says nothing. That is what an object store needs: GCS and S3 read Content-Encoding on an upload as the stored object's encoding, so declaring it there produces an object that is transparently decompressed on read — which then fails to load as a .jsonl.gz in BigQuery. Uploading a gzip file means the gzip bytes are the payload, not a transfer encoding.

context_dataobject

Workflow JSONata context (WorkflowContext.data) for preview

step_idstring

Step id used for ctx.current_step_id and recorded outputs

Response

Successful Response

statusstring required

SUCCESS or FAILURE

errorstring nullable

Step-level error message

status_codeinteger nullable
requestunknown
responseunknown

Changes

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