API Call - Upload Documents

Detailed specification and usage guide for the Upload Documents API call

This API call is used to send non media files when text documents in PDF, rich text or text format are required for text extraction to complete a Claudio workflow.  Data from these documents is automatically scraped in the Claudio workflow to be inserted into the generated transcript.

Description: Use this call to upload a new document to Claudio.  If more than one document needs to be uploaded, you will need to make a separate call for each document.

Parameters:

Name

Description

Usage

Type

Required

Key

API Key provided

In Request Body

string

True

Secret

API Secret provided

In Request Body

string

True

File

document for job

In Request Body (form data)

file

True

Expected Responses

{ "msg": "SUCCESS: File `[name of the document file with extension]` uploaded. ", "file_url": "[URL of the uploaded document]", "return": "msg,file_url"}

Status

Meaning

Description

200

OK

File upload is complete

400

Bad Request

Unexpected error occurred

401

Unauthorized

User not authorized

500

Internal Server Error

Internal Server Error

Next:  You are ready to Submit the Job to Claudio