Every endpoint in Files: 7 operations across 4 resources. Each one takes the same API key and returns the same error shapes as the rest of the API; see Authentication and Errors and limits.
Every path below is relative to https://app.jaicrm.ai. A key only reaches what it was granted when it was created, an endpoint you cannot use answers 403 rather than hiding.
Files
GET/api/files/{entityType}/{entityId}
Read one file
| Parameter | Type | Required | Notes |
|---|---|---|---|
entityType | string | Required | The record’s id. |
entityId | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/files/RECORD_ID/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/files/{entityType}/{entityId}
Act on a file
| Parameter | Type | Required | Notes |
|---|---|---|---|
entityType | string | Required | The record’s id. |
entityId | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/files/RECORD_ID/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'PATCH/api/files/{id}
Change a file
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X PATCH https://app.jaicrm.ai/api/files/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'DELETE/api/files/{id}
Delete a file
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/files/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Download
GET/api/files/download/{id}
Read one download
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/files/download/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Image
POST/api/files/image
Create an image
curl -X POST https://app.jaicrm.ai/api/files/image
-H 'Authorization: Bearer YOUR_API_KEY'Usage
GET/api/files/usage/summary
Read a summary for files
curl -X GET https://app.jaicrm.ai/api/files/usage/summary
-H 'Authorization: Bearer YOUR_API_KEY'Something missing or wrong here? Tell us. A question that needed asking usually means a page that needed writing.