HTTP Request

Make an HTTP request to a public URL and get the status, headers and body back. JSON, form, text and multipart file uploads; internal addresses are refused.

maker
infsh
category
other
runs via
api, javascript and python sdk, belt cli, mcp
updated
2026-10-13
price
from $0.00000277/sec

api reference

about

make an http request to a public url and get the status, headers and body back. json, form, text and multipart file uploads; internal addresses are refused.

get an api key

create one in settings → api keys. the examples read it from INFERENCE_API_KEY.

bash
1export INFERENCE_API_KEY="inf_your_key"

1. calling the api

install the client

nothing to install. any http client works; the examples use curl, and jq to read responses. every response wraps its result in a data field.

run and get result

send "wait": true to hold the connection until the task finishes. without it the call returns right away with the task still running.

bash
12# "wait": true holds the connection until the task finishes.3# the response is {"data": {"id", "status", "status_text", "output", ...}}4curl -X POST https://api.inference.sh/apps/run \5  -H "Authorization: Bearer $INFERENCE_API_KEY" \6  -H "Content-Type: application/json" \7  -d '{8    "app": "infsh/http",9    "input": {10      "url": "url"11    },12    "wait": true13  }'

stream live updates

get real-time progress updates as the task runs. ideal for showing progress bars, partial results, or long-running tasks. send "stream": true and the response is a server-sent event stream that ends when the task does.

bash
12# "stream": true answers with server-sent events until the task finishes3curl -N -X POST https://api.inference.sh/apps/run \4  -H "Authorization: Bearer $INFERENCE_API_KEY" \5  -H "Content-Type: application/json" \6  -d '{7    "app": "infsh/http",8    "input": {9      "url": "url"10    },11    "stream": true12  }'

run in the background

start the task and get its id back right away, then check on it later. for long tasks, or when you'd rather be called back, see webhooks.

bash
1# without "wait" the call returns the task right away (status 1, "received")2TASK_ID=$(curl -s -X POST https://api.inference.sh/apps/run \3  -H "Authorization: Bearer $INFERENCE_API_KEY" \4  -H "Content-Type: application/json" \5  -d '{6    "app": "infsh/http",7    "input": {8      "url": "url"9    }10  }' | jq -r '.data.id')1112# later: read its state. done when status is 10 (completed), 11 (failed) or 12 (cancelled)13curl -s https://api.inference.sh/tasks/$TASK_ID \14  -H "Authorization: Bearer $INFERENCE_API_KEY" | jq '.data | {status, status_text, output}'

2. authentication

the api uses api keys for authentication. see the authentication docs for detailed setup instructions.

3. files

file inputs are automatically handled by the sdk. you can pass local paths, urls, or base64 data.

automatic upload

pass urls directly or use data uris for inline content.

bash
1# pass URLs or data URIs as input values2curl -X POST https://api.inference.sh/apps/run \3  -H "Authorization: Bearer $INFERENCE_API_KEY" \4  -H "Content-Type: application/json" \5  -d '{6    "app": "infsh/http",7    "input": {8      "image": "https://example.com/image.png",9      "audio": "data:audio/mp3;base64,..."10    },11    "wait": true12  }'

manual upload

you can also upload files manually and use the returned url.

bash
1# 1. create the file: the response has an upload_url and the file's uri2FILE=$(curl -s -X POST https://api.inference.sh/files \3  -H "Authorization: Bearer $INFERENCE_API_KEY" \4  -H "Content-Type: application/json" \5  -d '{"files": [{"filename": "image.png", "content_type": "image/png"}]}')67# 2. PUT the bytes to upload_url8curl -X PUT "$(echo "$FILE" | jq -r '.data[0].upload_url')" \9  -H "Content-Type: image/png" \10  --data-binary @image.png1112# 3. pass the uri as an input value13echo "$FILE" | jq -r '.data[0].uri'

4. webhooks

get notified when a task completes by providing a webhook url. when the task reaches a terminal state (completed, failed, or cancelled), a POST request is sent to your url with the task result.

bash
1curl -X POST https://api.inference.sh/apps/run \2  -H "Authorization: Bearer $INFERENCE_API_KEY" \3  -H "Content-Type: application/json" \4  -d '{5    "app": "infsh/http",6    "input": {7        "url": "url"8    },9    "webhook": "https://your-server.com/webhook"10  }'

webhook payload

your endpoint receives a JSON POST with the task result:

json
1{2  "event": "task.completed",3  "timestamp": "2024-01-15T10:30:05Z",4  "data": {5    "id": "task_abc123",6    "short_id": "abc123",7    "status": 10,8    "status_text": "completed",9    "output": { ... },10    "created_at": "2024-01-15T10:30:00Z",11    "updated_at": "2024-01-15T10:30:05Z"12  }13}
eventstringtask.completed, task.failed or task.cancelled
timestampstringiso timestamp of the delivery
data.idstringtask id
data.short_idstringshort task id
data.statusnumberterminal status (10=completed, 11=failed, 12=cancelled, 13=rejected)
data.status_textstringthe status as a word: completed, failed or cancelled
data.outputobjecttask output (when completed)
data.errorstringerror message (when failed, omitted otherwise)
data.session_idstringsession id (when the task ran in a session, omitted otherwise)
data.created_atstringiso timestamp
data.updated_atstringiso timestamp

5. schema

input

methodstring

http method.

default: "GET"
options:"GET""POST""PUT""PATCH""DELETE""HEAD""OPTIONS"
urlstring*

request url. http or https only; must resolve to a public internet address.

headersobject

request headers. connection-level headers (host, content-length, connection, transfer-encoding, ...) are dropped. a value may hold {{secret.http_secret_name}}, filled from a secret given to the task.

queryobject

query parameters, added to any already in the url. a list repeats the key.

body_jsonany

json request body (any json value). sets content-type: application/json.

body_textstring

raw text request body. set content-type in headers (default text/plain; charset=utf-8).

formobject

form fields. sent application/x-www-form-urlencoded, or as multipart fields when files are given.

filesarray

files to upload as multipart/form-data, optionally with form fields.

timeout_secondsnumber

deadline for the whole request: connect, redirects and reading the body.

default: 30max:120
follow_redirectsboolean

follow 3xx redirects. each hop is checked like the first.

default: true
max_redirectsinteger

most redirects to follow.

default: 10min:0max:10
max_response_bytesinteger

largest response body to read (decoded bytes).

default: 10485760min:1max:104857600
truncateboolean

when the body exceeds max_response_bytes: true returns the first max_response_bytes with truncated=true, false fails the task.

default: false
response_asstring

auto: json to body_json, small text to body_text, anything else to body_file. json/text/file force one.

default: "auto"
options:"auto""json""text""file"

output

body_filestring(file)

body as a file, when binary, large, or response_as=file.

body_jsonany

parsed body, when it is json.

body_textstring

body as text, when it is text.

elapsed_msinteger*

time inside the app from sending the request to the end of the body.

final_urlstring*

url of the final response, after redirects.

headersobject*

response headers, lower-case names; repeated headers joined with ', '.

okboolean*

true when status is 2xx.

redirectsinteger

redirects followed.

size_bytesinteger

body bytes read (after content decoding).

statusinteger*

http status code of the final response.

truncatedboolean

true when the body was cut at max_response_bytes.

ready to run HTTP Request?

we use cookies

we use cookies to ensure you get the best experience on our website. for more information on how we use cookies, please see our cookie policy.

by clicking "accept", you agree to our use of cookies.
learn more.