Loading
Loading
Upload a PDF file as binary data to the APIFreaks PDF processing workspace. Returns a resource ID for use in subsequent PDF operations.
Upload a PDF file by sending the raw binary data in the request body. This method is useful for programmatic uploads where you already have the file content as a byte stream.
Authorize every request with your API key, passed either as a header or as a query parameter:
X-apiKeyapiKeyThis is version v1.0 of the API.
The PDF Binary Resource Upload API accepts a single PDF file sent as raw binary data in the request body, along with a required file_name query parameter.
The request body is the raw binary content of a single PDF file. The body is sent as application/octet-stream (binary stream), not as multipart/formdata.
{
"file": "Raw PDF bytes sent as application/octet-stream in the request body"
}filerequiredapplication/octet-streamRaw binary content of the PDF file. Send the file content as the request body with a Content-Type header of application/octet-stream.
All parameters must be included as query parameters.
formatoptionalStringdefault: jsonResponse format: 'json' (default) or 'xml'.
file_namerequiredStringName for your uploaded PDF file. Must end with .pdf extension (e.g., "document.pdf"). This is how the file will be stored on the server.
A successful request returns a 200 OK response with the uploaded file metadata.
fileIdUnique file ID for the uploaded PDF file. Use this ID to reference the file in subsequent API calls.
fileNameName of the uploaded PDF file.
Besides the response body, every response carries custom headers you can use to track credit usage, and concurrency usage on endpoints that enforce a concurrency limit. See the Custom Response Headers documentation and the endpoints with concurrency limits for more details.
X-Concurrent-Threadsheaderconcurrency-limited endpointsSpecifies the maximum number of concurrent requests allowed.
X-Concurrent-Threads-Activeheaderconcurrency-limited endpointsIndicates the number of active concurrent requests being processed.
X-AF-Credits-Costheaderall responsesSpecifies the number of credits consumed by the current request.
See the HTTP Status Codes documentation for a complete reference of common API errors and HTTP status codes.
Please provide a valid PDF file. Other file types are not supported.
Please provide a valid file name.