Http Client

HTTP Client

Use the http_client tool to make HTTP requests directly without needing curl or external binaries.

Tool: http_client

Parameters

Basic GET

Copy code
http_client(method="GET", url="https://api.example.com/users")

GET with query parameters

Copy code
http_client(method="GET", url="https://api.example.com/users?page=2&limit=10")

GET with custom headers

Copy code
http_client(method="GET", url="https://api.example.com/users", headers={"Accept": "application/json", "X-Custom-Header": "value"})

POST with JSON body

Copy code
http_client(method="POST", url="https://api.example.com/users", body="{\"name\": \"Alice\", \"email\": \"alice@example.com\"}")

The content_type defaults to json, which sets Content-Type: application/json automatically.

POST with form-encoded body

Copy code
http_client(method="POST", url="https://api.example.com/login", content_type="form", body="username=alice&password=secret")

POST with XML body

Copy code
http_client(method="POST", url="https://api.example.com/soap", content_type="xml", body="<request><action>query</action></request>")

PUT (full update)

Copy code
http_client(method="PUT", url="https://api.example.com/users/42", body="{\"name\": \"Alice Updated\", \"email\": \"alice@example.com\"}")

PATCH (partial update)

Copy code
http_client(method="PATCH", url="https://api.example.com/users/42", body="{\"name\": \"Alice Updated\"}")

DELETE

Copy code
http_client(method="DELETE", url="https://api.example.com/users/42")

HEAD (check resource existence)

Copy code
http_client(method="HEAD", url="https://api.example.com/users/42")

OPTIONS (check allowed methods)

Copy code
http_client(method="OPTIONS", url="https://api.example.com/users")

Authentication

Auth profiles (recommended)

Use the auth parameter with a configured profile name. Auth profiles support OAuth 1.0a, Basic, and Bearer authentication automatically:

Copy code
http_client(method="POST", url="https://api.twitter.com/2/tweets", auth="twitter", body="{\"text\": \"Hello!\"}")
http_client(method="GET", url="https://api.example.com/data", auth="my_api")

Manual headers

You can also pass auth headers manually:

Copy code
http_client(method="GET", url="https://api.example.com/me", headers={"Authorization": "Bearer eyJhbGciOi..."})
http_client(method="GET", url="https://api.example.com/me", headers={"Authorization": "Basic dXNlcjpwYXNz"})
http_client(method="GET", url="https://api.example.com/data", headers={"X-API-Key": "your-api-key"})

Download

Save a response directly to a file using download_path. Use the absolute paths from your system prompt:

Copy code
http_client(method="GET", url="https://example.com/report.pdf", download_path="/path/to/workspace/reports/report.pdf")

Download an image to the public media directory:

Copy code
http_client(method="GET", url="https://example.com/photo.jpg", download_path="/path/to/public/media/photo.jpg")

Returns: {"status": 200, "path": "/absolute/path/to/file", "size": 12345, "content_type": "application/pdf"}

Upload

Upload a file as multipart form data using upload_file:

Copy code
http_client(method="POST", url="https://api.example.com/upload", upload_file="reports/data.csv")

Custom field name (default is "file"):

Copy code
http_client(method="POST", url="https://api.example.com/upload", upload_file="images/logo.png", upload_field="image")

Upload with extra form fields (pass as JSON in body):

Copy code
http_client(method="POST", url="https://api.example.com/upload", upload_file="doc.pdf", body="{\"description\": \"Monthly report\"}")

Upload with auth:

Copy code
http_client(method="POST", url="https://api.example.com/upload", upload_file="data.csv", headers={"Authorization": "Bearer token123"})

Advanced Options

Custom timeout

Copy code
http_client(method="GET", url="https://slow-api.example.com/data", timeout=120)

Disable redirect following

Copy code
http_client(method="GET", url="https://example.com/redirect", follow_redirects=false)

Tips

• The response includes status, headers, body, and truncated fields.
• Response bodies larger than 50,000 characters are truncated.
• For APIs that return JSON, parse the response body as needed.
• The content_type parameter sets the Content-Type header automatically: json → application/json, form → application/x-www-form-urlencoded, text → text/plain, xml → application/xml.
• Use GET for reads, POST for creates, PUT for full replacements, PATCH for partial updates, DELETE for removals, HEAD for existence checks, OPTIONS for CORS/capability checks.
• Use download_path for binary files (images, PDFs, audio) — avoids encoding issues.
• Use upload_file for multipart uploads — auto-detects MIME type from file extension.