Agent Files

Upload agent file

post

This endpoint uploads an agent file associated with the provided API key.

Authorizations

Agent-Secret-Key

Agent-Secret-KeystringRequired

Custom authentication header

Body

multipart/form-data

filestring · binaryRequired

The file to upload

autoAddToVectorStorebooleanOptional

Indicates whether to automatically add the file to the vector store.

Example: true

Responses

200

Successfully uploaded agent file.

application/json

idstring · uuidRequired

Unique identifier for the agent file

Example: 123e4567-e89b-12d3-a456-426614174000

fileNamestringRequired

Name of the agent file

Example: example.txt

urlstringRequired

URL of the agent file

Example: https://example.com/file.txt

createdAtstring · date-timeRequired

Creation date of the agent file

Example: 2023-10-01T12:00:00Z

vectorStoreFileIdstringOptional

Unique identifier for the vector store file

Example: file-123e4567-e89b

isUploadedToVectorStoreboolean · nullableOptional

Indicates the file’s upload status to the vector store. A null value suggests a possible vector store error.

Example: true

uploadedToVectorStoreAtstring · date-timeOptional

Date when the file was uploaded to the vector store

Example: 2023-10-01T12:00:00Z

400

Failed to upload agent file.

application/json

403

Invalid API key or secret key. Ensure that you are using a valid authentication key.

application/json

500

Unexpected error occurred while processing the request. Please try again later.

application/json

post

/external/agent-files/upload

HTTPcURLJavaScriptPython

POST /external/agent-files/upload HTTP/1.1
Host: api.raia2.com
Agent-Secret-Key: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 45

{
  "file": "binary",
  "autoAddToVectorStore": true
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "fileName": "example.txt",
  "url": "https://example.com/file.txt",
  "createdAt": "2023-10-01T12:00:00Z",
  "vectorStoreFileId": "file-123e4567-e89b",
  "isUploadedToVectorStore": true,
  "uploadedToVectorStoreAt": "2023-10-01T12:00:00Z"
}

Get agent files by API key

get

This endpoint retrieves the agent files associated with the provided API key.

Authorizations

Agent-Secret-Key

Agent-Secret-KeystringRequired

Custom authentication header

Responses

200

Successfully retrieved agent files with details.

application/json

idstring · uuidRequired

Unique identifier for the agent file

Example: 123e4567-e89b-12d3-a456-426614174000

fileNamestringRequired

Name of the agent file

Example: example.txt

urlstringRequired

URL of the agent file

Example: https://example.com/file.txt

createdAtstring · date-timeRequired

Creation date of the agent file

Example: 2023-10-01T12:00:00Z

vectorStoreFileIdstringOptional

Unique identifier for the vector store file

Example: file-123e4567-e89b

isUploadedToVectorStoreboolean · nullableOptional

Indicates the file’s upload status to the vector store. A null value suggests a possible vector store error.

Example: true

uploadedToVectorStoreAtstring · date-timeOptional

Date when the file was uploaded to the vector store

Example: 2023-10-01T12:00:00Z

403

Invalid API key or secret key. Ensure that you are using a valid authentication key.

application/json

404

Agent files not found.

application/json

500

Unexpected error occurred while processing the request. Please try again later.

application/json

get

/external/agent-files/by-api-key

HTTPcURLJavaScriptPython

GET /external/agent-files/by-api-key HTTP/1.1
Host: api.raia2.com
Agent-Secret-Key: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "fileName": "example.txt",
  "url": "https://example.com/file.txt",
  "createdAt": "2023-10-01T12:00:00Z",
  "vectorStoreFileId": "file-123e4567-e89b",
  "isUploadedToVectorStore": true,
  "uploadedToVectorStoreAt": "2023-10-01T12:00:00Z"
}

Delete agent files by IDs

delete

This endpoint deletes the agent files by ids

Authorizations

Agent-Secret-Key

Agent-Secret-KeystringRequired

Custom authentication header

Body

application/json

fileIdsstring · uuid[]Required

Responses

200

Successfully deleted agent files.

No content

403

Invalid API key or secret key. Ensure that you are using a valid authentication key.

application/json

500

Unexpected error occurred while processing the request. Please try again later.

application/json

delete

/external/agent-files

HTTPcURLJavaScriptPython

DELETE /external/agent-files HTTP/1.1
Host: api.raia2.com
Agent-Secret-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "fileIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

No content

Delete agent file by ID

delete

This endpoint deletes the agent file by id

Authorizations

Agent-Secret-Key

Agent-Secret-KeystringRequired

Custom authentication header

Path parameters

idstringRequired

The ID of the agent file to delete.

Example: 5f7b1b3b-3b3b-4b3b-3b3b-3b3b3b3b3b3b

Responses

200

Successfully deleted agent file.

No content

403

Invalid API key or secret key. Ensure that you are using a valid authentication key.

application/json

404

Agent file not found.

application/json

500

Unexpected error occurred while processing the request. Please try again later.

application/json

delete

/external/agent-files/{id}/delete

HTTPcURLJavaScriptPython

DELETE /external/agent-files/{id}/delete HTTP/1.1
Host: api.raia2.com
Agent-Secret-Key: YOUR_API_KEY
Accept: */*

No content

Delete agent file from vector store by ID

delete

This endpoint deletes the agent file from vector store by id

Authorizations

Agent-Secret-Key

Agent-Secret-KeystringRequired

Custom authentication header

Path parameters

idstringRequired

The ID of the agent file to delete from vector store.

Example: 5f7b1b3b-3b3b-4b3b-3b3b-3b3b3b3b3b3b

Responses

200

Successfully deleted agent file from vector store.

No content

403

Invalid API key or secret key. Ensure that you are using a valid authentication key.

application/json

404

Agent file not found.

application/json

500

Unexpected error occurred while processing the request. Please try again later.

application/json

delete

/external/agent-files/{id}/delete-from-vector-store

HTTPcURLJavaScriptPython

DELETE /external/agent-files/{id}/delete-from-vector-store HTTP/1.1
Host: api.raia2.com
Agent-Secret-Key: YOUR_API_KEY
Accept: */*

No content

Add agent file to vector store by ID

put

This endpoint adds the agent file to vector store by id

Authorizations

Agent-Secret-Key

Agent-Secret-KeystringRequired

Custom authentication header

Path parameters

idstringRequired

The ID of the agent file to add to vector store.

Example: 5f7b1b3b-3b3b-4b3b-3b3b-3b3b3b3b3b3b

Responses

200

Successfully added agent file to vector store.

No content

403

Invalid API key or secret key. Ensure that you are using a valid authentication key.

application/json

404

Agent file not found.

application/json

500

Unexpected error occurred while processing the request. Please try again later.

application/json

put

/external/agent-files/{id}/add-to-vector-store

HTTPcURLJavaScriptPython

PUT /external/agent-files/{id}/add-to-vector-store HTTP/1.1
Host: api.raia2.com
Agent-Secret-Key: YOUR_API_KEY
Accept: */*

No content