Skip to main content
POST
Synchronous extraction for a file end to end

Authorizations

X-API-Key
string
header
required

Path Parameters

project_name
string
required

The name of the project

table_id
string<uuid>
required

The ID of the table

Body

application/json
mimetype
enum<string>
required

the mimetype of the document being uploaded

Available options:
application/pdf,
application/json,
image/jpg,
image/jpeg,
image/png,
text/csv,
text/plain,
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet,
application/vnd.ms-excel,
video/mp4,
audio/mp3,
audio/wav,
audio/ogg,
multipart/related,
message/rfc822
filename
string
required

the name of the file being uploaded

file_type
enum<string>
required

Indicates whether the file is a binary upload or a signed link to the document.

Available options:
uri,
binary,
multipart
file
required

A signed URL to the file.

Response

Successfully extracted file

data
object
required

Object with direct values for each key, allowing single values or arrays of values.

created_at
string<date-time>
required
row_id
string<uuid>
required
reasoning
string
review
object
status
enum<string>

status of the AI run

Available options:
running,
done,
error,
pending
input
object