Init Job
curl --request POST \
--url https://api.example.com/v1/jobs/initimport requests
url = "https://api.example.com/v1/jobs/init"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/v1/jobs/init', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/jobs/init",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/jobs/init"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/jobs/init")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/jobs/init")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyAPI Reference
Init Job
Create a new batch job and get a signed URL to upload your prompts file.
POST
/
v1
/
jobs
/
init
Init Job
curl --request POST \
--url https://api.example.com/v1/jobs/initimport requests
url = "https://api.example.com/v1/jobs/init"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/v1/jobs/init', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/jobs/init",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/jobs/init"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/jobs/init")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/jobs/init")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyRequest
Headers
| Header | Required | Description |
|---|---|---|
X-API-Key | Yes | Your PromptForge API key |
Content-Type | Yes | application/json |
Body
| Field | Type | Required | Description |
|---|---|---|---|
provider | string | Yes | LLM provider. One of: openai, anthropic, gemini, mistral |
model | string | Yes | Model name as accepted by the provider (e.g. gpt-4o-mini) |
max_retries | integer | No | Max retries per prompt on transient errors. Default: 3 |
rpm | integer | No | Override requests-per-minute limit. If omitted, PromptForge learns it automatically. |
tpm | integer | No | Override tokens-per-minute limit. If omitted, PromptForge learns it automatically. |
If you omit
rpm and tpm, PromptForge uses a slow-start algorithm to discover your actual provider rate limits dynamically. This is the recommended approach.Example request
curl
curl -X POST https://api.promptforge.dev/v1/jobs/init \
-H "X-API-Key: $PROMPTFORGE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"provider": "openai",
"model": "gpt-4o-mini",
"max_retries": 3
}'
Python
import requests
res = requests.post(
"https://api.promptforge.dev/v1/jobs/init",
headers={"X-API-Key": "your-api-key"},
json={"provider": "openai", "model": "gpt-4o-mini", "max_retries": 3}
)
data = res.json()
# data["job_id"], data["upload_url"], data["expires_at"]
Response
Status:202 Accepted
| Field | Type | Description |
|---|---|---|
job_id | string (UUID) | Unique identifier for this job. Use it for all subsequent calls. |
upload_url | string | Pre-signed GCS URL. PUT your prompts.jsonl here. |
expires_at | string (ISO 8601) | When the upload URL expires. |
{
"job_id": "3f7a1c2e-4b5d-6e7f-8a9b-0c1d2e3f4a5b",
"upload_url": "https://storage.googleapis.com/promptforge-input/client-xyz/3f7a1c2e/prompts.jsonl?X-Goog-Signature=...",
"expires_at": "2024-01-15T10:30:00Z"
}
Errors
| Status | When |
|---|---|
400 | Missing required fields or malformed JSON |
401 | Missing or invalid X-API-Key |
422 | Unsupported provider or model value |
Next step
After a202 response, upload your prompts.jsonl file to the upload_url using a PUT request:
curl -X PUT "$UPLOAD_URL" \
-H "Content-Type: application/octet-stream" \
--data-binary @prompts.jsonl
⌘I