upload_file
Create a staging record and return a signed upload URL. Upload the file via HTTP PUT to the returneduploadUrl. After the upload completes, you must call upload_completed to trigger processing.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | UUID | Yes | - | Project ID |
resourceType | string | Yes | - | contract or statement |
fileName | string | Yes | - | Original file name (e.g. contract.pdf) |
fileType | string | No | application/pdf | MIME type of the file |
fileSize | integer | Yes | - | File size in bytes |
extractions | string[] | No | - | Extractions to run after upload (contract only) |
entities, artists, writers, royalties, splits, costs, compensations, dates, accounting-periods, types, signatures, control-areas, creative-approvals, balances, recordings, compositions, relations
Sample prompt: “Upload contract.pdf and extract royalties and dates”
upload_completed
Signal that a file upload is complete. Call this after successfully uploading the file via HTTP PUT to theuploadUrl returned by upload_file. This triggers processing.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
stagingId | string | Yes | - | Staging ID returned from upload_file |
projectId | UUID | Yes | - | Project ID |
resourceType | string | Yes | - | contract or statement |
upload_status
Check the processing status of an uploaded contract or statement.| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
stagingId | string | Yes | - | Staging ID returned from upload_file |
projectId | UUID | Yes | - | Project ID |
resourceType | string | Yes | - | contract or statement |
download_file
Get a signed download URL for a contract or statement file. The URL expires in 1 hour.| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
resourceId | string | Yes | - | Contract ID or Statement ID |
projectId | UUID | Yes | - | Project ID |
resourceType | string | Yes | - | contract or statement |