Upload a file

POST

/v1/files

Code sample: curl

API="${PARSEHAWK_API_URL:-http://127.0.0.1:8000}"
curl --fail --silent --show-error \
  --request POST "$API/v1/files" \
  --form "upload=@document.pdf;type=application/pdf" | jq .

• Default local ParseHawk API

Store a document locally and return metadata for parsing or extraction jobs.

Request Body^required

Media typemultipart/form-data

Body_uploadFile

object

upload

required

Upload

PDF, image, text, or Markdown document to store and reuse.

string

Responses

201

Successful Response

Media typeapplication/json

FileResponse

Metadata for a file stored by ParseHawk.

object

id

required

Id

Immutable file identifier.

string

file_name

required

File Name

Original upload filename.

string

content_type

required

Content Type

Detected or supplied media type.

string

size_bytes

required

Size Bytes

Stored file size in bytes.

integer

sha256

required

Sha256

Lowercase SHA-256 digest of the stored bytes.

string

source

required

FileSource

How the file entered ParseHawk.

string

Allowed values: user example

is_example

required

Is Example

Whether the file ships as a built-in example.

boolean

created_at

required

Created At

UTC creation time.

string format: date-time

Example

{
  "id": "file_01JZ6QK8M7",
  "file_name": "invoice.pdf",
  "content_type": "application/pdf",
  "source": "user"
}

422

The request or domain input failed validation.

Media typeapplication/json

ApiErrorResponse

Error returned by request validation or a ParseHawk domain service.

object

code

Any of:

string

string

null

null

detail

required

Any of:

string

string

Array<object>

Array<object>

object

key

additional properties

any

Example^generated

{
  "code": "example",
  "detail": [
    {}
  ]
}

500

Unexpected server error.

Media typeapplication/json

ApiErrorResponse

Error returned by request validation or a ParseHawk domain service.

object

code

Any of:

string

string

null

null

detail

required

Any of:

string

string

Array<object>

Array<object>

object

key

additional properties

any

Example^generated

{
  "code": "example",
  "detail": [
    {}
  ]
}

503

Persistence is temporarily busy and the request can be retried.

Media typeapplication/json

ApiErrorResponse

Error returned by request validation or a ParseHawk domain service.

object

code

Any of:

string

string

null

null

detail

required

Any of:

string

string

Array<object>

Array<object>

object

key

additional properties

any

Example^generated

{
  "code": "example",
  "detail": [
    {}
  ]
}