
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.
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.
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.
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.
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.
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.
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.
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.
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:
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}5. schema
input
http method.
request url. http or https only; must resolve to a public internet address.
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.
query parameters, added to any already in the url. a list repeats the key.
json request body (any json value). sets content-type: application/json.
raw text request body. set content-type in headers (default text/plain; charset=utf-8).
form fields. sent application/x-www-form-urlencoded, or as multipart fields when files are given.
files to upload as multipart/form-data, optionally with form fields.
deadline for the whole request: connect, redirects and reading the body.
follow 3xx redirects. each hop is checked like the first.
most redirects to follow.
largest response body to read (decoded bytes).
when the body exceeds max_response_bytes: true returns the first max_response_bytes with truncated=true, false fails the task.
auto: json to body_json, small text to body_text, anything else to body_file. json/text/file force one.
output
body as a file, when binary, large, or response_as=file.
parsed body, when it is json.
body as text, when it is text.
time inside the app from sending the request to the end of the body.
url of the final response, after redirects.
response headers, lower-case names; repeated headers joined with ', '.
true when status is 2xx.
redirects followed.
body bytes read (after content decoding).
http status code of the final response.
true when the body was cut at max_response_bytes.
new models
- P
Pika H3 Flex Audio Stems
pika/pika-h3-flex-audio-stems
audio$0.001/stem-sec (3 stems: dialogue, music, effect) - P
Pika H3 Flex Upscale
pika/pika-h3-flex-upscale
video$0.05-$0.14/sec (480p src), $0.03-$0.12/sec (768p src); 1080p/2K/4K targets - P
Pika H3 Flex Reference to Video
pika/pika-h3-flex-reference
video$0.06/sec 480p, $0.12/sec 768p, $0.15/sec 1080p, $0.16/sec 2k, $0.20/sec 4k (output+input video sec). Stems: $0.001/sec - P
Pika H3 Flex
pika/pika-h3-flex
video$0.02/sec 480p, $0.04/sec 768p, $0.07/sec 1080p, $0.08/sec 2K, $0.16/sec 4K; stems +$0.001/stem-sec - J
JEV-9B
autotrust/jev-9b
decisionfrom $0.00055833/sec
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.