Skip to main content

HTTP requests

Supply an HTTP URL for an action to use as an input, or to call an upstream API.

interfaces:
http/basic:
output: http
method: GET
actions:
- name: BasicHTTP
http:
url: https://jsonplaceholder.typicode.com/todos/1

HTTP actions also support auth (bearer / basic / digest), TLS options, multipart uploads, automatic pagination, and reverse-proxy passthrough. Every field is documented below.

HttpRequest

FieldTypeDescription
urlstringRequired.
digest_auth_userstring (nullable)
digest_auth_passstring (nullable)
userstring (nullable)
passstring (nullable)
proxystring (nullable)
headersMap<string, string> (nullable)
bodyany
base64_bytesstring (nullable)
methodstring (nullable)
data_typeDataType (nullable)
bearer_authstring (nullable)
multipartArray<MultipartPart> (nullable)A flat list of parts for a multipart/form-data request. Each entry is one form part. Whether it is a text or binary part is determined implicitly by which source field is… Example ↓
multipart_formMap<string, string> (nullable)Deprecated: use multipart instead.
multipart_filesArray<MultipartData> (nullable)Deprecated: use multipart instead.
accept_invalid_certsboolean (nullable)
castring (nullable)
root_certificatesArray<string> (nullable)
timeoutstring (nullable)
connect_timeoutstring (nullable)
paginationPagination (nullable)
proxy_bodyboolean (nullable)
proxy_methodboolean (nullable)
proxy_headersProxyHeaders (nullable)
proxy_queryboolean (nullable)

Field examples

multipart

A flat list of parts for a multipart/form-data request.

Each entry is one form part. Whether it is a text or binary part is determined implicitly by which source field is provided:

  • value → plain text part
  • b64 → binary part decoded from base64
  • file_path → binary part read from disk (not allowed in managed/hosted mode)

filename and mime are always optional. When omitted on a binary part, mime is guessed from the filename extension, falling back to application/octet-stream.

multipart:
- name: image
b64: a|previous_action::body.image.data|
filename: photo.png # optional — sent as Content-Disposition filename
mime: image/png # optional — guessed from filename if absent
- name: model
value: gpt-image-1
- name: prompt
value: Transform into Studio Ghibli style

Pagination

FieldTypeDescription
original_urlstring (nullable)
next_linkstring (nullable)
no_pagesnumberDefault: 0.
page_markernumberDefault: 0.
cursor_markerstring (nullable)
incrementnumberDefault: 1.
max_pagesnumber (nullable)
max_pages_keystring (nullable)
page_startnumberDefault: 1.
page_next_keystring (nullable)
page_limitnumber (nullable)
page_limit_keystring (nullable)
payload_keystring (nullable)
next_cursor_keystring (nullable)
max_cursor_keystring (nullable)
next_link_keystring (nullable)
next_link_hoststring (nullable)

MultipartPart

A single part in a multipart/form-data request.

Exactly one of value, b64, or file_path must be provided per part. All other fields are optional.

FieldTypeDescription
namestringRequired. Form field name — the name attribute sent in Content-Disposition.
valuestring (nullable)Plain text value. Use this for non-binary form fields. Mutually exclusive with b64 and file_path.
b64string (nullable)Base64-encoded binary data. Decoded before sending. Mutually exclusive with value and file_path.
file_pathstring (nullable)Path to a file to read and send as binary data. Not permitted in managed/hosted mode — use b64 instead. Mutually exclusive with value and b64.
filenamestring (nullable)Filename sent in the Content-Disposition header for this part (e.g. photo.png). Optional for binary parts; not meaningful for plain text parts.
mimestring (nullable)MIME type for this part (e.g. image/png, application/pdf). If omitted on a binary part, guessed from filename's extension. Falls back to application/octet-stream when…

MultipartData

Deprecated: use [MultipartPart] via the multipart field instead.

One of:

MultipartFile

Deprecated: use [MultipartPart] via the multipart field instead.

FieldTypeDescription
file_pathstring (nullable)
file_namestringRequired.
b64string (nullable)
mime_strstring (nullable)
part_namestring (nullable)

MultipartText

Deprecated: use [MultipartPart] via the multipart field instead.

FieldTypeDescription
keystringRequired.
valuestringRequired.
mime_strstring (nullable)

ProxyHeaders

Controls which headers are passed through from the incoming request.

One of:

  • boolean — When true, pass through all incoming headers
  • Array<string> — When a list, pass through only the specified headers; empty list means pass none