Image

Sign upLogin

Table of contents

Page Id

File API

This documentation is valid for:

This API provides endpoints to manage files. It allows you to upload, get, list, delete, and get the content of files.

Check the Globant Enterprise AI API Reference for generic variables needed to use the API.

Endpoints

Method	Path	Description
POST	/files	Uploads a file
GET	/files/{fileId}	Gets a file by Id
DELETE	/files/{fileId}	Deletes a file by Id
GET	/files/{fileId}/content	Gets the content of a file by Id
GET	/files/all	Gets all files

Note: The fileId parameter refers to the file Id.

POST /files

Uploads a file to the system.

Parameters

Request Body:

Name	Type	Description
file	File	The file you want to upload.

Headers:

Name	Type	Description
Authorization	string	BearerToken for authentication.
fileName	string	File name (optional). If not provided, the name of the uploaded file will be used.
organizationId	string	Organization ID.
projectId	string	Project ID.
folder	string	Destination folder (optional). If not provided, the file will be temporarily saved.

Response

{
    "dataFileId": "string", 
    "dataFileUrl": "string",
    "success": true
}

cURL Sample

curl -X POST "$BASE_URL/v1/files" 
  -H "Authorization: Bearer $SAIA_PROJECT_APITOKEN" 
  -H "Accept: application/json"
  -H "fileName: $FILE_NAME"
  -H "organizationId: $ORGANIZATION_ID"
  -H "projectId: $PROJECT_ID"
  -H "folder: $FOLDER"
  -F "file=@/path/to/file.txt"

GET /files/{fileId}

Gets a file by Id.

This endpoint requires a Globant Enterprise AI API token related to organization scope.

Parameters

Name	Type	Description
organization	string	Organization Id.
project	string	Project Id.
fileId	string	File Id.

Response

{
    "dataFileExtension": "string",
    "dataFileId": "string",
    "dataFileName": "string",
    "dataFilePurpose": "string"
    "dataFileSize": numeric,
    "dataFileUrl": "string",
    "organizationId": "string",
    "projectId": "string",
    "success": true
}

cURL Sample

curl -X GET "$BASE_URL/v1/files/{fileId}" 
  -H "Authorization: Bearer $SAIA_APITOKEN" 
  -H "Accept: application/json"
  -G 
  -d "organization=$ORGANIZATION_ID" 
  -d "project=$PROJECT_ID"

DELETE /files/{fileId}

Deletes a file by Id.

This endpoint requires a Globant Enterprise AI API token related to organization scope.

Parameters

Name	Type	Description
fileId	string	File Id.

Response

{
    "success": true
}

cURL Sample

curl -X DELETE "$BASE_URL/v1/files/{fileId}"
  -H "Authorization: Bearer $SAIA_APITOKEN"
  -H "Accept: application/json"
  -G
  -d "organization=$ORGANIZATION_ID"
  -d "project=$PROJECT_ID"

GET /files/{fileId}/content

Gets the content of a file by Id.

This endpoint requires a Globant Enterprise AI API token related to organization scope.

Parameters

Name	Type	Description
organization	string	Organization Id.
project	string	Project Id.
fileId	string	File Id.

Response

{
    "content": "string"
  }

cURL Sample

curl -X GET "$BASE_URL/v1/files/{fileId}/content" 
  -H "Authorization: Bearer $SAIA_APITOKEN" 
  -H "Accept: application/json"
  -G 
  -d "organization=$ORGANIZATION_ID" 
  -d "project=$PROJECT_ID"

GET /files/all

Gets all files.

This endpoint requires a Globant Enterprise AI API token related to organization scope.

Parameters

Name	Type	Description
organization	string	Organization Id.
project	string	Project Id.

Response

{
  "dataFiles": 
    {
      "DataFileExtension": "string",
      "DataFileId": "string",
      "DataFileName": "string",
      "DataFilePurpose": "string",
      "DataFileSize": "number",
      "DataFileUrl": "string"
    },
    {
      "DataFileExtension": "string",
      "DataFileId": "string",
      "DataFileName": "string",
      "DataFilePurpose": "string",
      "DataFileSize": "number",
      "DataFileUrl": "string"
    }
  
}

cURL Sample

curl -X GET "$BASE_URL/v1/files/all" 
  -H "Authorization: Bearer $SAIA_APITOKEN" 
  -H "Accept: application/json"
  -G 
  -d "organization=$ORGANIZATION_ID" 
  -d "project=$PROJECT_ID"