v2

latestOpenAPI 3.0.02026-08-0793108394.2 KB

Media Upload

Upload media to Encircle

Uploads media from the raw request body and returns a temporary upload_id which expires after 24 hours from being issued.

The upload_id should be used within that time to attach the Upload to another object, such as a Property Claim.

post/v1/upload

Headers

X-Encircle-Attributionstring

String used to internally identify which integrator made this request on behalf of their users.

Integrators should reuse the same 'X-Encircle-Attribution' value for all their users.

This attribution enables Encircle to provide better assistance to integrators if they encounter any issues.

If not specified, the request will not be associated with any integration services.

X-Encircle-Requeststring

Unique string used to identify each specific request.

Any retries due to connection failures should reuse the same 'X-Encircle-Request' value. This helps prevent duplicate requests from unintentionally being processed again.

If not specified, the request will be treated as unique and it will be processed normally.

Request body

{"stackTrail":"paths:/v1/upload:post:requestBody:content:application/json:schema","oasType":"schema","type":"unknown","description":"Raw binary data."}

Response

The Upload was successfully created.

upload_idstring uuid required

Used for attaching media to an object. They are created via POST /upload and expire after 24 hours since being issued.

A RFC 4122 compliant UUID in lowercase hexadecimal.

Example response

{
  "upload_id": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
}