Portable Asset Manifest for an asset

GET

/v1/assets/{id}/manifest

const url = 'https://api.trustysweep.com/v1/assets/example/manifest';
const options = {method: 'GET', headers: {cookie: 'sweep_session=<sweep_session>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.trustysweep.com/v1/assets/example/manifest \
  --cookie sweep_session=<sweep_session>

Authorizations

sessionCookie
sessionToken
apiKey
inventory:read
oauth2
inventory:read

Parameters

Path Parameters

required

string

/^ast_[0-9A-HJKMNP-TV-Z]{26}$/

Responses

200

application/json

Portable Asset Manifest v1: a provider-independent, versioned, exportable description of one asset and its lineage.

object

manifestVersion

required

string

Allowed values: 1.0

manifestId

required

Prefixed ULID (mfs_…)

string

/^mfs_[0-9A-HJKMNP-TV-Z]{26}$/

assetId

required

Prefixed ULID (ast_…)

string

/^ast_[0-9A-HJKMNP-TV-Z]{26}$/

tenantRef

required

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

source

required

object

provider

required

string

Allowed values: google_gmail google_drive microsoft_outlook microsoft_onedrive dropbox apple_local s3_compatible trusty_vault simulated

sourceRef

required

string

accountLabel

string

objectId

required

string

parentId

One of:

string
null

string

version

One of:

string
null

string

path

One of:

string
null

string

containers

Array<string>

createdAt

One of:

string
null

string format: date-time

modifiedAt

One of:

string
null

string format: date-time

observedAt

required

string format: date-time

providerMetadata

object

key

additional properties

content

required

object

kind

required

string

Allowed values: message attachment file folder photo video statement other

name

required

string

sizeBytes

required

integer

mimeType

One of:

string
null

string

sha256

One of:

string
null

string

partSha256

Array<string>

message

object

from

string

Array<string>

subject

string

date

string format: date-time

threadId

string

listId

string

listUnsubscribe

string

listUnsubscribePost

boolean

labels

Array<string>

snippet

string

permissions

Array<object>

object

principal

required

string

role

required

string

Allowed values: owner writer commenter reader unknown

type

required

string

Allowed values: user group domain anyone link unknown

preservedAtDestination

boolean

vault

One of:

object
null

object

vaultObjectId

required

string

storageKey

required

string

sha256

required

string

sizeBytes

required

integer

storageClass

string

Allowed values: standard infrequent_access

committedAt

required

string format: date-time

verifiedAt

required

string format: date-time

verification

required

string

Allowed values: hash_match size_and_etag part_hashes

transformations

Array<object>

object

type

required

string

Allowed values: raw_mime_capture attachment_extract text_extract ocr thumbnail format_normalize repackage

producedAt

required

string format: date-time

producer

required

string

outputRef

string

outputSha256

string

lossy

boolean

notes

string

derived

Array<object>

object

ref

required

string

type

required

string

sha256

string

destinations

Array<object>

object

destinationId

required

string

provider

required

string

Allowed values: google_gmail google_drive microsoft_outlook microsoft_onedrive dropbox apple_local s3_compatible trusty_vault simulated

objectId

One of:

string
null

string

path

One of:

string
null

string

mode

required

string

Allowed values: copy move restore

executionId

required

string

writtenAt

required

string format: date-time

verified

required

boolean

lossiness

Array<string>

lineage

Array<object>

object

from

required

string

required

string

relation

required

string

Allowed values: originated_from preserved_as derived_from moved_to restored_to duplicated_by copied_to

required

string format: date-time

executionId

string

executions

Array<string>

restore

required

object

capable

required

boolean

methods

Array<string>

Allowed values: vault_to_original vault_to_destination provider_untrash

originalRestorable

boolean

notes

string

hash

string

Example

{
  "manifestVersion": "1.0",
  "manifestId": "mfs_01J8Z3K9M2Q4R6S8T0V2W4X6Y8",
  "assetId": "ast_01J8Z3K9M2Q4R6S8T0V2W4X6Y8",
  "source": {
    "provider": "google_gmail"
  },
  "content": {
    "kind": "message"
  },
  "permissions": [
    {
      "role": "owner",
      "type": "user"
    }
  ],
  "vault": {
    "storageClass": "standard",
    "verification": "hash_match"
  },
  "transformations": [
    {
      "type": "raw_mime_capture"
    }
  ],
  "destinations": [
    {
      "provider": "google_gmail",
      "mode": "copy"
    }
  ],
  "lineage": [
    {
      "relation": "originated_from"
    }
  ],
  "restore": {
    "methods": [
      "vault_to_original"
    ]
  }
}

Headers

RateLimit-Limit

integer

Requests allowed in the current window.

RateLimit-Remaining

integer

Requests remaining in the current window.

RateLimit-Reset

integer

Seconds until the window resets.

400

Validation failed

application/problem+json

RFC 9457 problem details.

object

type

required

Https://developers.trustysweep.com/errors/

string format: uri

titlerequired

string

statusrequired

integer

detail

string

coderequired

Machine-readable error code from errors.json

string

request_idrequired

string

errors

Array<object>

object

pathrequired

string

messagerequired

string

`Example^generated`

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

`401`

Section titled “401”

Unauthenticated

Media typeapplication/problem+json
RFC 9457 problem details.
object
typerequired
Https://developers.trustysweep.com/errors/

string format: uri
titlerequired
string
statusrequired
integer
detail
string
coderequired
Machine-readable error code from errors.json

string
request_idrequired
string
errors
Array<object>
object
pathrequired
string
messagerequired
string
Example^generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

`403`

Section titled “403”

Forbidden / action denied / step-up required

Media typeapplication/problem+json
RFC 9457 problem details.
object
typerequired
Https://developers.trustysweep.com/errors/

string format: uri
titlerequired
string
statusrequired
integer
detail
string
coderequired
Machine-readable error code from errors.json

string
request_idrequired
string
errors
Array<object>
object
pathrequired
string
messagerequired
string
Example^generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

`404`

Section titled “404”

Not found

Media typeapplication/problem+json
RFC 9457 problem details.
object
typerequired
Https://developers.trustysweep.com/errors/

string format: uri
titlerequired
string
statusrequired
integer
detail
string
coderequired
Machine-readable error code from errors.json

string
request_idrequired
string
errors
Array<object>
object
pathrequired
string
messagerequired
string
Example^generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

`429`

Section titled “429”

Rate limited

Media typeapplication/problem+json
RFC 9457 problem details.
object
typerequired
Https://developers.trustysweep.com/errors/

string format: uri
titlerequired
string
statusrequired
integer
detail
string
coderequired
Machine-readable error code from errors.json

string
request_idrequired
string
errors
Array<object>
object
pathrequired
string
messagerequired
string
Example^generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

`Headers`

Section titled “Headers”

Retry-After

integer

Seconds to wait before retrying.

RateLimit-Limit

integer

Requests allowed in the current window.

RateLimit-Remaining

integer

Requests remaining in the current window.

RateLimit-Reset

integer

Seconds until the window resets.

`500`

Section titled “500”

Internal error

Media typeapplication/problem+json
RFC 9457 problem details.
object
typerequired
Https://developers.trustysweep.com/errors/

string format: uri
titlerequired
string
statusrequired
integer
detail
string
coderequired
Machine-readable error code from errors.json

string
request_idrequired
string
errors
Array<object>
object
pathrequired
string
messagerequired
string
Example^generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

Portable Asset Manifest for an asset

Authorizations

Parameters

Path Parameters

Responses

200

Example

Headers

400

Examplegenerated

401

Examplegenerated

403

Examplegenerated

404

Examplegenerated

429

Examplegenerated

Headers

500

Examplegenerated

`Example^generated`

`401`

`Example^generated`

`403`

`Example^generated`

`404`

`Example^generated`

`429`

`Example^generated`

`Headers`

`500`

`Example^generated`