Upload file | Respan Docs

Upload a file for use with OpenAI Batch API. The uploaded file is stored on OpenAI’s servers and can be used to create batch jobs for asynchronous LLM request processing.

Customer credentials required: This endpoint requires your own OpenAI API key configured in Respan dashboard (Settings → Providers). Respan passes the request through to OpenAI’s infrastructure.

Request body

The request must use multipart/form-data encoding.

file file required: The file to upload. Must be a valid JSONL (JSON Lines) file for batch processing.

Example JSONL format

1   {"custom_id": "request-1", "method": "POST", "url": "/v1/chat/completions", "body": {"model": "gpt-4", "messages": [{"role": "user", "content": "Hello!"}]}}
2   {"custom_id": "request-2", "method": "POST", "url": "/v1/chat/completions", "body": {"model": "gpt-3.5-turbo", "messages": [{"role": "user", "content": "How are you?"}]}}

purpose string required: The intended purpose of the file. For batch jobs, use "batch".

Supported values:
- "batch" - For use with the Batch API

Response

Returns a file object with metadata about the uploaded file.

200 OK

1 {
2   "id": "file-abc123",
3   "object": "file",
4   "bytes": 1024,
5   "created_at": 1677610602,
6   "filename": "batch_input.jsonl",
7   "purpose": "batch"
8 }

400 Bad Request - No OpenAI Key

1 {
2   "error": "OpenAI API key not configured"
3 }

400 Bad Request - Invalid Purpose

1 {
2   "error": {
3     "message": "Invalid value for 'purpose': must be one of ['batch', ...]",
4     "type": "invalid_request_error"
5   }
6 }

401 Unauthorized

1 {
2   "error": "Authentication credentials were not provided."
3 }

Python

1 url = "https://api.respan.ai/api/files/"
2 headers = {
3     "Authorization": "Bearer YOUR_API_KEY"
4 }
5 
6 with open("batch_input.jsonl", "rb") as f:
7     files = {"file": f}
8     data = {"purpose": "batch"}
9     response = requests.post(url, headers=headers, files=files, data=data)
10 
11 print(response.json())

TypeScript

1 const url = 'https://api.respan.ai/api/files/';
2 const formData = new FormData();
3 formData.append('file', fileInput.files[0]);
4 formData.append('purpose', 'batch');
5 
6 const response = await fetch(url, {
7     method: 'POST',
8     headers: {
9         'Authorization': 'Bearer YOUR_API_KEY'
10     },
11     body: formData
12 });
13 
14 const data = await response.json();
15 console.log(data);

cURL

$ curl https://api.respan.ai/api/files/ \
>   -H "Authorization: Bearer YOUR_API_KEY" \
>   -F "file=@batch_input.jsonl" \
>   -F "purpose=batch"

Upload a file for use with OpenAI Batch API. The uploaded file is stored on OpenAI's servers and can be used to create batch jobs for asynchronous LLM request processing. <Note> **Customer credentials required**: This endpoint requires your own OpenAI API key configured in Respan dashboard (Settings → Providers). Respan passes the request through to OpenAI's infrastructure. </Note> ## Request body The request must use `multipart/form-data` encoding. - `file` *file* **required**: The file to upload. Must be a valid JSONL (JSON Lines) file for batch processing. **Example JSONL format** ```jsonl {"custom_id": "request-1", "method": "POST", "url": "/v1/chat/completions", "body": {"model": "gpt-4", "messages": [{"role": "user", "content": "Hello!"}]}} {"custom_id": "request-2", "method": "POST", "url": "/v1/chat/completions", "body": {"model": "gpt-3.5-turbo", "messages": [{"role": "user", "content": "How are you?"}]}} ``` - `purpose` *string* **required**: The intended purpose of the file. For batch jobs, use `"batch"`. **Supported values:** - `"batch"` - For use with the Batch API ## Response Returns a file object with metadata about the uploaded file. ```json 200 OK { "id": "file-abc123", "object": "file", "bytes": 1024, "created_at": 1677610602, "filename": "batch_input.jsonl", "purpose": "batch" } ``` ```json 400 Bad Request - No OpenAI Key { "error": "OpenAI API key not configured" } ``` ```json 400 Bad Request - Invalid Purpose { "error": { "message": "Invalid value for 'purpose': must be one of ['batch', ...]", "type": "invalid_request_error" } } ``` ```json 401 Unauthorized { "error": "Authentication credentials were not provided." } ``` ```python Python url = "https://api.respan.ai/api/files/" headers = { "Authorization": "Bearer YOUR_API_KEY" } with open("batch_input.jsonl", "rb") as f: files = {"file": f} data = {"purpose": "batch"} response = requests.post(url, headers=headers, files=files, data=data) print(response.json()) ``` ```typescript TypeScript const url = 'https://api.respan.ai/api/files/'; const formData = new FormData(); formData.append('file', fileInput.files[0]); formData.append('purpose', 'batch'); const response = await fetch(url, { method: 'POST', headers: { 'Authorization': 'Bearer YOUR_API_KEY' }, body: formData }); const data = await response.json(); console.log(data); ``` ```bash cURL curl https://api.respan.ai/api/files/ \ -H "Authorization: Bearer YOUR_API_KEY" \ -F "file=@batch_input.jsonl" \ -F "purpose=batch" ```

Authentication

AuthorizationBearer

API key authentication. Get your API key from https://platform.respan.ai/platform/api-keys

Request

This endpoint expects a multipart form containing a file.

filefileRequired

The file to upload. Must be a valid JSONL (JSON Lines) file for batch processing.

purposestringRequired

The intended purpose of the file. For batch jobs, use “batch”. Supported values: - “batch” - For use with the Batch API

Response

Successful response for Upload file

Errors

401

Unauthorized Error

Upload a file for use with OpenAI Batch API. The uploaded file is stored on OpenAI’s servers and can be used to create batch jobs for asynchronous LLM request processing.

Request body

The request must use multipart/form-data encoding.

file file required: The file to upload. Must be a valid JSONL (JSON Lines) file for batch processing.

Example JSONL format

1   {"custom_id": "request-1", "method": "POST", "url": "/v1/chat/completions", "body": {"model": "gpt-4", "messages": [{"role": "user", "content": "Hello!"}]}}
2   {"custom_id": "request-2", "method": "POST", "url": "/v1/chat/completions", "body": {"model": "gpt-3.5-turbo", "messages": [{"role": "user", "content": "How are you?"}]}}

purpose string required: The intended purpose of the file. For batch jobs, use "batch".

Supported values:
- "batch" - For use with the Batch API

Response

Returns a file object with metadata about the uploaded file.

200 OK

1 {
2   "id": "file-abc123",
3   "object": "file",
4   "bytes": 1024,
5   "created_at": 1677610602,
6   "filename": "batch_input.jsonl",
7   "purpose": "batch"
8 }

400 Bad Request - No OpenAI Key

1 {
2   "error": "OpenAI API key not configured"
3 }

400 Bad Request - Invalid Purpose

1 {
2   "error": {
3     "message": "Invalid value for 'purpose': must be one of ['batch', ...]",
4     "type": "invalid_request_error"
5   }
6 }

401 Unauthorized

1 {
2   "error": "Authentication credentials were not provided."
3 }

Python

1 url = "https://api.respan.ai/api/files/"
2 headers = {
3     "Authorization": "Bearer YOUR_API_KEY"
4 }
5 
6 with open("batch_input.jsonl", "rb") as f:
7     files = {"file": f}
8     data = {"purpose": "batch"}
9     response = requests.post(url, headers=headers, files=files, data=data)
10 
11 print(response.json())

TypeScript

1 const url = 'https://api.respan.ai/api/files/';
2 const formData = new FormData();
3 formData.append('file', fileInput.files[0]);
4 formData.append('purpose', 'batch');
5 
6 const response = await fetch(url, {
7     method: 'POST',
8     headers: {
9         'Authorization': 'Bearer YOUR_API_KEY'
10     },
11     body: formData
12 });
13 
14 const data = await response.json();
15 console.log(data);

cURL

$ curl https://api.respan.ai/api/files/ \
>   -H "Authorization: Bearer YOUR_API_KEY" \
>   -F "file=@batch_input.jsonl" \
>   -F "purpose=batch"

1	import requests
2
3	url = "https://api.respan.ai/api/files/"
4
5	files = { "file": "open('string', 'rb')" }
6	payload = { "purpose": "string" }
7	headers = {"Authorization": "Bearer <token>"}
8
9	response = requests.post(url, data=payload, files=files, headers=headers)
10
11	print(response.json())

1	{"custom_id": "request-1", "method": "POST", "url": "/v1/chat/completions", "body": {"model": "gpt-4", "messages": [{"role": "user", "content": "Hello!"}]}}
2	{"custom_id": "request-2", "method": "POST", "url": "/v1/chat/completions", "body": {"model": "gpt-3.5-turbo", "messages": [{"role": "user", "content": "How are you?"}]}}

1	{
2	"id": "file-abc123",
3	"object": "file",
4	"bytes": 1024,
5	"created_at": 1677610602,
6	"filename": "batch_input.jsonl",
7	"purpose": "batch"
8	}

1	{
2	"error": {
3	"message": "Invalid value for 'purpose': must be one of ['batch', ...]",
4	"type": "invalid_request_error"
5	}
6	}

1	{
2	"error": "Authentication credentials were not provided."
3	}

1	url = "https://api.respan.ai/api/files/"
2	headers = {
3	"Authorization": "Bearer YOUR_API_KEY"
4	}
5
6	with open("batch_input.jsonl", "rb") as f:
7	files = {"file": f}
8	data = {"purpose": "batch"}
9	response = requests.post(url, headers=headers, files=files, data=data)
10
11	print(response.json())

1	const url = 'https://api.respan.ai/api/files/';
2	const formData = new FormData();
3	formData.append('file', fileInput.files[0]);
4	formData.append('purpose', 'batch');
5
6	const response = await fetch(url, {
7	method: 'POST',
8	headers: {
9	'Authorization': 'Bearer YOUR_API_KEY'
10	},
11	body: formData
12	});
13
14	const data = await response.json();
15	console.log(data);

$	curl https://api.respan.ai/api/files/ \
>	-H "Authorization: Bearer YOUR_API_KEY" \
>	-F "file=@batch_input.jsonl" \
>	-F "purpose=batch"