Skip to content

For AI agents: every API docs page in one plain-text file is at /docs/llms-full.txt, and the documentation index is at /llms.txt. This page is available as Markdown at https://diffio.ai/docs/api-reference/reopen-project-upload.md, and every docs URL returns Markdown when requested with Accept: text/markdown.

Get new upload instructions

Returns fresh multipart upload instructions (with a new 24-hour upload_token) for a project whose file has not arrived yet.

POST https://api.diffio.ai/v2/projects/{project_id}/upload

  • Key scope: projects:write
  • Auth header:Authorization: Bearer <apiKey>
  • Body: None

Request

Pass project_id in the path; send no body (or {}).

Path parameters

FieldTypeRequiredDescription
#project_idstringRequired: YesUnique identifier of the project.

Headers

FieldTypeRequiredDescription
#Diffio-End-UserstringRequired: NoOptional end-user identifier (up to 128 characters). Scopes the request to that end user's projects; omit to act across the whole account.

Request

import os
from diffio import DiffioClient

key = os.environ["DIFFIO_API_KEY"]
client = DiffioClient(api_key=key)

project = client.projects.reopen_upload(
    "62f62565-049f-5e7e-bbd2-9de0cf7ddbfe",
)

Response

Returns the project with renewed upload descriptors pointing to the same destination.

Success: 200OK.

Response fields

FieldTypePresentDescription
#idstringAlwaysUnique project identifier (UUID).
#objectstringAlwaysResource type, always "project".project
#statusstringAlwaysUpload and preparation state: awaiting_upload until bytes arrive, preparing while media is probed, ready when ready to restore, or failed.awaiting_uploadpreparingreadyfailed
#uploadobject | nullAlwaysMultipart upload instructions for sending the file to the media edge, or null on an idempotent replay after the upload has arrived.Fields below
upload 11 fields
FieldTypePresentDescription
#upload.upload_session_idstringAlwaysUpload session identifier (api-{project_id}).
#upload.edge_base_urlstringAlwaysOrigin URL of the media upload edge (https://media.diffio.io).
#upload.upload_tokenstringAlwaysSigned bearer token sent as Authorization: Bearer <token> on every upload edge request.
#upload.part_size_bytesintegerAlwaysRequired byte length for every upload part except the last (33554432, 32 MiB).
#upload.max_bytesintegerAlwaysMaximum total upload size in bytes (2147483648, 2 GB).
#upload.expires_atstringAlwaysISO 8601 UTC timestamp when upload_token expires (24 hours after minting); renew via POST /projects/{project_id}/upload.
#upload.requestsobjectAlwaysPre-built HTTP request descriptors for the multipart upload (start, part, complete, abort).
#upload.requests.startobjectAlwaysDescriptor (method, url, headers, body, returns, description) called once first to obtain uploadId.
#upload.requests.partobjectAlwaysDescriptor called once per part (numbered from 1) with raw bytes as the PUT body; save each returned etag.
#upload.requests.completeobjectAlwaysDescriptor called once after all parts finish, sending uploadId and the ordered parts array (partNumber, etag).
#upload.requests.abortobjectAlwaysOptional descriptor to discard uploaded parts for an unfinished uploadId.
Other response fields16 fields
FieldTypePresentDescription
#file_namestring | nullAlwaysRecording filename as sent at creation, or null.
#content_typestring | nullAlwaysMIME type sent at creation (application/octet-stream when none was sent), or null.
#size_bytesinteger | nullAlwaysFile size in bytes: the uploaded byte count once the upload arrives, before that the size_bytes sent at creation; null when unknown.
#duration_secondsnumber | nullAlwaysRecording duration in seconds once status is ready, or null while awaiting upload or preparing.
#has_videobooleanAlwaysTrue when the recording has video: inferred from content_type or the file name until the upload is probed, then from the file itself.
#end_userstring | nullAlwaysEnd-user identifier from the Diffio-End-User header at creation, or null for account-level projects.
#metadataobjectAlwaysKey-value string map saved with the project ({} when none was supplied).
#generation_countintegerAlwaysTotal number of generations created for this project.
Show all 16 fields (8 more)
FieldTypePresentDescription
#video_preview_statusstring | nullAlwaysState of a video project's picture-only HLS stream (video_hls): preparing, ready, or failed; null for audio projects.preparingreadyfailed
#share_idstring | nullAlwaysPublic 17-character share identifier while a share is published, or null when unshared.
#latest_generationobject | nullAlwaysNewest Generation object on this project, or null when no generation exists yet.
#created_atstring | nullAlwaysISO 8601 UTC timestamp when the project was created, or null.
#updated_atstring | nullAlwaysISO 8601 UTC timestamp when the project last changed, or null.
#errorobject | nullAlwaysFailure details when status is failed, or null otherwise.
#error.codestringAlwaysStable snake_case project failure code (media_processing_failed or project_failed).
#error.messagestringAlwaysHuman-readable explanation of why the upload could not be prepared.

Response 200OK.

Return codes

  • 200OK.Returns the project with renewed 24-hour upload instructions.
  • 400Bad request.Malformed JSON body, or Diffio-End-User exceeds 128 characters. invalid_jsoninvalid_header
  • 403Forbidden: the key lacks permission.Key is inactive or lacks projects:write. permission_denied
  • 404Not found.No project with that project_id exists for this account and end user. project_not_found
  • 409Conflict: see error.code for which one.The project's file has already arrived, with details.project_status reporting its current status. upload_already_received
  • 401Unauthorized: the API key is missing or invalid.405Client error.Same on every endpoint
    • 401Unauthorized: the API key is missing or invalid. Missing API key (code missing_api_key), or invalid API key (code invalid_api_key).
    • 405Client error. HTTP method not supported on this path; check the Allow header (code method_not_allowed).

Example error response

Errors are JSON: an error object with code, message and request_id. An unrecognized key returns 401Unauthorized: the API key is missing or invalid.:

Error response
{
  "error": {
    "code": "invalid_api_key",
    "message": "Invalid API key.",
    "request_id": "dead773b60e148fd9e22d680a22fa701"
  }
}

Notes

  • Only projects in status: "awaiting_upload" accept new upload instructions; once the upload arrives, create a new project to upload a different file.
  • Both SDKs call this from projects.upload(...) when you pass a project id instead of the created project; the Python SDK also calls it when upload.expires_at is less than 60 seconds away.

Report an issue with this page