Get URLs to upload files

POST 
/v1/upload

Get URLs to upload files and use in different tasks (parsing, extraction, etc.).

Request

application/json

Body

required

files

object[]

required

List of files to prepare for upload. Each file must have a unique ID, size in bytes, and content type.

Array [

id Id (string)required

Unique identifier for the file in your request. Use this to match the response with your original file.

size Size (integer)required

Possible values: >= 1

File size in bytes. Must be at least 1 byte.

content_type Content Type (string)required

MIME type of the file (e.g., "application/pdf")

]

Responses

201

The URLs to upload the files to.

application/json

Schema

Schema

files

object[]

required

List of upload information for each file in your request. Each file gets its own upload URL and task (parsing, extraction, etc.) id.

Array [

request_id Request Id (string)required

The ID you provided in your request. Use this to match the response with your original file.

upload_url Upload Url (string)required

URL for uploading your file. Use this URL with a PUT request to upload your file content.

nomic_url Nomic Url (string)required

Use this URL to reference the file when making calls to parsing or extraction services.

file_id File Id (string)required

The ID of the file in the parsing service. (deprecated)

presigned_url Presigned Url (string)required

The presigned URL to upload the file to. (deprecated)

]

Example (from schema)

{
  "files": [
    {
      "request_id": "string",
      "upload_url": "string",
      "nomic_url": "string",
      "file_id": "string",
      "presigned_url": "string"
    }
  ]
}

403

The user is not authorized to perform this action.

application/json

Schema

Schema

any

Example (from schema)

{
  "status_code": 403,
  "detail": "The user is not authorized to perform this action."
}

Example

{
  "status_code": 403,
  "detail": "The user is not authorized to perform this action."
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...