API Documents Q&A

Find answers to common questions about managing documents through API.

How Do I Upload a Document in Filevine through the API?

1. Create URL for upload. This action creates a temporary S3 url to upload a document.
   https://filevine.stoplight.io/docs/v2-us/c5009ec0c1d04-create-document-url-for-upload 
2. Upload document. Use the URL returned from step one and attach the actual document.
   Note: This is not a Filevine API call. It is a PUT request to the AWS URL returned from the first step.
3. Add the document to the project. Use the documentID returned from step one. https://filevine.stoplight.io/docs/v2-us/32989758d1eb7-add-document-to-project 

To manipulate documents within sections, refer to the different options:

• To add a document to a field in a non-collection section: https://filevine.stoplight.io/docs/v2-us/6a7ab25c342fb-update-form 
• To add a document to a field in a new collection item: https://filevine.stoplight.io/docs/v2-us/a517d24a9ce13-create-collection-item
• To add a document to a field in an existing collection item: https://filevine.stoplight.io/docs/v2-us/c6c86edda2ed2-update-collection-item

How Do I Update a Doc Revision?

1. Create URL for upload This action creates a temporary S3 url to upload a document.
   https://filevine.stoplight.io/docs/v2-us/c5009ec0c1d04-create-document-url-for-upload
2. Upload document. Use the url returned from step one and attach the actual document.
   Note: This is not a Filevine API call. It is a PUT request to the AWS URL returned from the first step.
3. Add Doc Revision. The documentID is the ID of the document that you want to replace. This will replace the document on the project and the version will be updated.
   https://filevine.stoplight.io/docs/v2-us/598610ed45f8a-add-document-revision 

Why is My Uploaded File Corrupt when Previewing?

The "Upload Document" call is not a Filevine endpoint but is owned and managed by AWS instead. So, we can only offer a few suggestions:

1. Make sure the document is not corrupt prior to uploading it to Filevine.
2. Verify that the content type is correct for the document you are uploading. This should match the content type that is returned from the "Create Document URL" step (ex. application/pdf).

Be sure to check if your file type is listed in the unsupported file types article.