POST
/
v1
/
buckets
/
{bucket_identifier}
/
objects
/
create
curl --request POST \
  --url https://api.mixpeek.com/v1/buckets/{bucket_identifier}/objects/create \
  --header 'Content-Type: application/json' \
  --data '{
  "blobs": [
    {
      "data": {
        "num_pages": 5,
        "title": "Service Agreement 2024"
      },
      "key_prefix": "/contract-2024/content.pdf",
      "metadata": {
        "author": "John Doe",
        "department": "Legal"
      },
      "property": "content",
      "type": "json"
    },
    {
      "data": {
        "filename": "https://example.com/images/smartphone-x1.jpg",
        "mime_type": "image/jpeg"
      },
      "key_prefix": "/contract-2024/thumbnail.jpg",
      "metadata": {
        "height": 300,
        "width": 200
      },
      "property": "thumbnail",
      "type": "image"
    }
  ],
  "key_prefix": "/documents",
  "metadata": {
    "category": "contracts",
    "status": "draft",
    "year": 2024
  }
}'
{
  "task_id": "<string>",
  "status": "PENDING",
  "inputs": [
    "<any>"
  ],
  "outputs": [
    "<any>"
  ]
}

Headers

​
Authorization
string | null

Bearer token authentication using your API key. Format: 'Bearer your_api_key'. To get an API key, create an account at mixpeek.com/start and generate a key in your account settings. Example: 'Bearer sk_1234567890abcdef'

​
X-Namespace
string | null

Optional namespace for data isolation. This can be a namespace name or namespace ID. Example: 'netflix_prod' or 'ns_1234567890'. To create a namespace, use the /namespaces endpoint.

Path Parameters

​
bucket_identifier
string
required

Identifier of the bucket

Body

application/json

Request model for creating a bucket object

​
key_prefix
string | null

Storage key/path prefix of the object, this will be used to retrieve the object from the storage. It's at the root of the object.

Example:

"/contract-2024"

​
blobs
object[]

List of blobs to be created in this object

Request model for creating a new blob

Example:
[
  {
    "data": {
      "num_pages": 5,
      "title": "Service Agreement 2024"
    },
    "key_prefix": "/content.pdf",
    "metadata": {
      "author": "John Doe",
      "department": "Legal"
    },
    "property": "content",
    "type": "PDF"
  }
]
​
metadata
object

Additional metadata for the object, this will be appended in all downstream documents of the your connected collections.

Example:
{
  "category": "contracts",
  "status": "draft",
  "year": 2024
}
​
skip_duplicates
boolean
default:false

Skip duplicate blobs, if a blob with the same hash already exists, it will be skipped.

Response

200
application/json
Successful Response
​
task_id
string
required
​
status
enum<string>
Available options:
DONE,
FAILED,
SKIPPED,
CANCELLED,
PROCESSING,
DOWNLOADING,
INITIALIZING,
UPLOADING,
QUEUED,
PENDING,
CONVERTING
​
inputs
any[] | null
​
outputs
any[] | null

Was this page helpful?

Suggest editsRaise issue