content

Change an item’s name or note

patch/workspaces/{id}/content/{itemId}

Request

  • Base URL: https://api.swingfactor.ai/v1
  • URL: https://api.swingfactor.ai/v1/workspaces/{id}/content/{itemId}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

The workspace's id (a UUID).

itemIdstring uuid required

The content's item id (a UUID).

Request body

namestring
notestring nullable

Response

The item.

idstring uuid required
kind'sources' required
origin'upload' | 'web' required

Where its bytes come from: an upload, or a web page.

namestring required

A file’s name; a page’s title, or its address until it is read.

notestring nullable required

What it is for, in the words of whoever added it.

urlstring nullable required

A page’s address. Null for an upload.

status'pending' | 'ready' required
contentTypestring nullable required
sizeinteger nullable required

Bytes: as declared while an upload is pending, as stored once ready.

currentVersionIdstring uuid nullable required

The version it reads as now.

readStatus'waiting' | 'reading' | 'read' | 'no_text' | 'failed' | 'not_read' | 'null' nullable required

For a kind that is read: how far reading its text has got.

readErrorstring nullable required

Why the last reading came to nothing, in words.

textCharsinteger nullable required

Characters of text read out.

readAtstring nullable required
checkedAtstring nullable required

When its origin was last asked whether it changed.

addedBystring uuid nullable required
addedByNamestring nullable required

Kept when the account that added it is gone.

addedByActorstring nullable required

What added it where no person did: the product, for what its model found.

createdAtstring required

Changes

No recorded changes to this operation across all 1 revision of this API.