Files

Add a file

Add an uploaded file to a project, account, contact, intake, or the Library: pass exactly one of projectId, accountId, contactId, intakeId, or library. Create the upload with POST /uploads and PUT the file's bytes to its url first. Parley then extracts the file's text in the background, and the file can be read once its status is ready. Adding the same upload again returns the same file; adding it anywhere else returns 409 UPLOAD_ALREADY_ADDED.

post/files

Request

  • Base URL
    https://api.parley.so/v1
  • URL
    https://api.parley.so/v1/files
  • Auth
    HTTP bearer

Request body

projectIdstring

Add it to this project's files. Pass exactly one of projectId, accountId, contactId, intakeId, or library.

accountIdstring

Add it to this account's files. Pass exactly one of projectId, accountId, contactId, intakeId, or library.

contactIdstring

Add it to this contact's files. Pass exactly one of projectId, accountId, contactId, intakeId, or library.

intakeIdstring

Add it to this intake's files. Pass exactly one of projectId, accountId, contactId, intakeId, or library.

libraryunknown
uploadIdstring required

The id of an upload, once its bytes have been PUT to its url, holding the file to add. It keeps its file name. Adding the same upload again returns the same file.

folderIdstring

Put it inside this folder. Omit for the top level.

Response

Created.

OR

Changes

No recorded changes to this operation across all 2 revisions of this API.