Wexa AI
  1. Files
Wexa AI
  • Wexa AI
  • Getting Started with Wexa AI
  • Use Cases and Workflows
  • API Reference
  • Tutorials
  • Troubleshooting Guide
  • API Endpoints
    • Project
      • create project
      • Get all projects
      • Get project
      • update project
      • Delete project
    • Agentflows
      • create agentflow
      • get agentflows
      • Get agentflow by projectId and UserId
      • get agentflow by id
      • Add skilled agent to agentflow
      • Update skilled agent
    • Connectors
      • get connectors by projectid
      • get connector by Id
      • Delete a connector
      • connector update status
      • get all available trigger actions
    • Skills
      • create skill
      • get skills
      • get skills by category'
      • get skills by id
      • skills by name
    • Executeflow
      • create executeflow
      • get executions
      • execute agentflow
      • pause executeflow
      • resume execution
      • cancel executeflow
      • get execution by execution id
      • get execution details for monitoring
    • Customer
      • get customer
      • Get credit history
    • Actions
      • create action
      • get action
    • Files
      • upload files
        POST
      • get files by fileid
        GET
      • get connector by fileid
        GET
      • get files by connector_id
        GET
    • Inbox
      • get inbox
    • Tags
      • tags
    • Tasks
      • get tasks
      • get task by id
      • Pause running task
      • resume task
      • Stop task
    • Tables
      • create table
      • create database
      • get tables
      • get records list
      • get table names
      • delete record
      • delete a column
    • Dashboard
      • get dashboard
      • refresh dashboard
      • delete component in dashboard
    • Settings
      • get settings
    • Marketplace
      • get all connectors
      • get marketplace coworkers
      • get marketplace coworker by id
    • Coworker schedules
      • get schedules
      • create coworker schedule
      • get schedule coworker by its id
      • update schedule by its id
      • delete schedule by its id
    • Analytics
      • Get analytics
    • Marketplace coworkers
      • hire a coworker
      • check marketplace coworker update
    • Project member
      • project_member
  1. Files

get connector by fileid

GET
https://api.wexa.ai/file/{projectID}/{file_id}/connector
Last modified:2025-04-25 11:08:14

Retrieve Connector by File ID#

Use this endpoint to retrieve the connector associated with a specific file within a project in your Wexa.ai environment. This functionality allows you to access metadata about the connector, such as its type, configuration, and status, facilitating the management and monitoring of file integrations.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.wexa.ai/file///connector' \
--header 'x-api-key: {{x-api-key}}'
Response Response Example
{
  "_id": "68060c4c064a778a5f18f9f7",
  "name": "File Upload - Durga_prasad_new_resume.pdf-68060c4c064a778a5f18f9f5",
  "description": "Use the uploaded files to be served as Knowledge base for coworkers.",
  "category": "file_upload",
  "status": "failed",
  "connector_type": "system",
  "connector_group_tag": null,
  "user_id": null,
  "org_id": "67fdea40aac77be632954f0f",
  "projectID": "67fdea40aac77be632954f13",
  "config": {
    "fileIDs": [
      "68060c4c064a778a5f18f9f5"
    ]
  },
  "tags": [
    "haha"
  ],
  "logo": "https://klotdev.blob.core.windows.net/connectors/file_upload.png",
  "readme_b64": "IyBGaWxlIFVwbG9hZCBDb25uZWN0b3IgSW50ZWdyYXRpb24gR3VpZGUKCiMjIEludHJvZHVjdGlvbgoKVGhlIEZpbGUgVXBsb2FkIGNvbm5lY3RvciBmYWNpbGl0YXRlcyB0aGUgc2VhbWxlc3MgdXBsb2FkaW5nIGFuZCBwcm9jZXNzaW5nIG9mIGZpbGVzIHdpdGhpbiB5b3VyIGFwcGxpY2F0aW9uLiBUaGlzIGd1aWRlIHByb3ZpZGVzIGRldGFpbGVkIGluc3RydWN0aW9ucyBvbiBjb25maWd1cmluZyBhbmQgdXRpbGl6aW5nIHRoZSBGaWxlIFVwbG9hZCBDb25uZWN0b3IgdG8gaGFuZGxlIGZpbGUgdXBsb2FkcyBlZmZlY3RpdmVseS4KCiMjIEdldHRpbmcgU3RhcnRlZCB3aXRoIEZpbGUgVXBsb2FkIENvbm5lY3RvcgoKVG8gYmVnaW4gdXNpbmcgdGhlIEZpbGUgVXBsb2FkIENvbm5lY3RvciwgZm9sbG93IHRoZXNlIHN0ZXBzOgoKMS4gKipDb25maWd1cmUgRmlsZSBVcGxvYWQgQ29ubmVjdG9yOioqIENvbmZpZ3VyZSB0aGUgRmlsZSBVcGxvYWQgQ29ubmVjdG9yIGJ5IHNwZWNpZnlpbmcgdGhlIGxpc3Qgb2YgZmlsZSBJRHMgdG8gYmUgdXBsb2FkZWQuCjIuICoqUmVnaXN0ZXIgQ29ubmVjdG9yOioqIFJlZ2lzdGVyIHRoZSBjb25uZWN0b3Igd2l0aCB0aGUgcHJvdmlkZWQgY29uZmlndXJhdGlvbi4KMy4gKipWYWxpZGF0ZSBDb25maWd1cmF0aW9uOioqIFZhbGlkYXRlIHRoZSBjb25uZWN0b3IgY29uZmlndXJhdGlvbiB0byBlbnN1cmUgaXQgbWVldHMgdGhlIHJlcXVpcmVtZW50cy4KNC4gKipVc2UgRmlsZSBVcGxvYWQgVUkgRm9ybToqKiBVdGlsaXplIHRoZSBwcm92aWRlZCBVSSBmb3JtIHRvIGlucHV0IHRoZSBmaWxlIFVSTHMgZm9yIHVwbG9hZC4KCiMjIENvbmZpZ3VyaW5nIHRoZSBGaWxlIFVwbG9hZCBDb25uZWN0b3IKClRoZSBGaWxlIFVwbG9hZCBDb25uZWN0b3IgcmVxdWlyZXMgY29uZmlndXJhdGlvbiB3aXRoIHRoZSBmb2xsb3dpbmcgcGFyYW1ldGVyczoKCi0gKipGaWxlIElEczoqKiBBIGxpc3Qgb2YgZmlsZSBJRHMgdG8gYmUgdXBsb2FkZWQuCgojIyMgQ29uZmlndXJhdGlvbiBFeGFtcGxlCgpgYGB5YW1sCmZpbGVfaWRzOgogIC0gImZpbGVfaWRfMSIKICAtICJmaWxlX2lkXzIiCiAgLSAiZmlsZV9pZF8zIgpgYGAKCiMjIFV0aWxpemluZyB0aGUgRmlsZSBVcGxvYWQgQ29ubmVjdG9yCgpUaGUgRmlsZSBVcGxvYWQgQ29ubmVjdG9yIHN1cHBvcnRzIHRoZSBmb2xsb3dpbmcgZnVuY3Rpb25hbGl0aWVzOgoKMS4gRmlsZSBVcGxvYWQKICAgIC0gVXBsb2FkIEZpbGVzOiBVcGxvYWQgZmlsZXMgYnkgcHJvdmlkaW5nIHRoZWlyIFVSTHMgdGhyb3VnaCB0aGUgcHJvdmlkZWQgVUkgZm9ybS4KCjIuIEZpbGUgUHJvY2Vzc2luZwogICAgLSBQcm9jZXNzIEZpbGVzOiBQcm9jZXNzIGFsbCB1cGxvYWRlZCBmaWxlcyBieSBpbnZva2luZyB0aGUgZW5kcG9pbnQgYC9maWxlX3VwbG9hZC9wdWxsYC4KCiMjIEVuZHBvaW50IERldGFpbHMKCi0gYFBPU1QgL2ZpbGVfdXBsb2FkL2NvbmZpZ2A6IFJlZ2lzdGVyIG9yIHVwZGF0ZSB0aGUgY29uZmlndXJhdGlvbiBmb3IgdGhlIEZpbGUgVXBsb2FkIENvbm5lY3Rvci4KLSBgR0VUIC9maWxlX3VwbG9hZC9jb25maWcve2Nvbm5lY3RvcklEfWA6IFJldHJpZXZlIHRoZSBjb25maWd1cmF0aW9uIGZvciBhIHNwZWNpZmljIGNvbm5lY3Rvci4KLSBgREVMRVRFIC9maWxlX3VwbG9hZC9jb25maWcve2Nvbm5lY3RvcklEfWA6IERlbGV0ZSB0aGUgY29uZmlndXJhdGlvbiBmb3IgYSBzcGVjaWZpYyBjb25uZWN0b3IuCi0gYFBPU1QgL2ZpbGVfdXBsb2FkL2NvbmZpZy97Y29ubmVjdG9ySUR9L3ZhbGlkYXRlYDogVmFsaWRhdGUgdGhlIGNvbmZpZ3VyYXRpb24gZm9yIGEgc3BlY2lmaWMgY29ubmVjdG9yLgotIGBQT1NUIC9maWxlX3VwbG9hZC9jb25maWcve2Nvbm5lY3RvcklEfS9yZWZyZXNoYDogUmVmcmVzaCB0aGUgY29uZmlndXJhdGlvbiBmb3IgYSBzcGVjaWZpYyBjb25uZWN0b3IuCi0gYFBPU1QgL2ZpbGVfdXBsb2FkL3B1bGxgOiBQcm9jZXNzIGFsbCB1cGxvYWRlZCBmaWxlcyBmb3IgaW5nZXN0aW9uLgoKIyMgQWN0aW9ucwoKLSBgcHVsbF9jb25uZWN0b3JgCiAgLSBEZXNjcmlwdGlvbjogRmV0Y2hlcyBkYXRhIGFib3V0IHRoZSBwcm92aWRlZCBjb25maWd1cmF0aW9uIGFuZCBpbmdlc3RzIGRhdGEgaW50byBRZHJhbnQgc3RvcmFnZS4KICAtIElucHV0czogTm9uZQogIC0gT3V0cHV0czogTm9uZQoKIyMgVHJpZ2dlcnMKClRoZSBGaWxlIFVwbG9hZCBjb25uZWN0b3IgZG9lcyBub3QgY3VycmVudGx5IHN1cHBvcnQgc3BlY2lmaWMgdHJpZ2dlcnMuIEhvd2V2ZXIsIGNvd29ya2VyIHRyaWdnZXJzIGNvdWxkIGJlIGF0dGFjaGVkIGZvciB0aGlzIGNvbm5lY3Rvci4KCiMjIEJlc3QgUHJhY3RpY2VzCgotIFNlY3VyaXR5OiBFbnN1cmUgc2VjdXJlIGhhbmRsaW5nIG9mIGZpbGUgVVJMcyB0byBwcmV2ZW50IHVuYXV0aG9yaXplZCBhY2Nlc3MuCi0gVmFsaWRhdGlvbjogVmFsaWRhdGUgdGhlIHByb3ZpZGVkIGZpbGUgVVJMcyB0byBlbnN1cmUgdGhleSBhcmUgYWNjZXNzaWJsZSBhbmQgdmFsaWQuCi0gUGVyZm9ybWFuY2UgT3B0aW1pemF0aW9uOiBPcHRpbWl6ZSBmaWxlIHVwbG9hZCBhbmQgcHJvY2Vzc2luZyBvcGVyYXRpb25zIHRvIG1pbmltaXplIGxhdGVuY3kgYW5kIGltcHJvdmUgb3ZlcmFsbCBwZXJmb3JtYW5jZS4KCiMjIENvbmNsdXNpb24KCkluIGNvbmNsdXNpb24sIHRoZSBGaWxlIFVwbG9hZCBDb25uZWN0b3Igc2VydmVzIGFzIGEgdmFsdWFibGUgdG9vbCBmb3IgaGFuZGxpbmcgZmlsZSB1cGxvYWRzIGFuZCBwcm9jZXNzaW5nIHdpdGhpbiB5b3VyIGFwcGxpY2F0aW9uLiBCeSBjb25maWd1cmluZyBhbmQgdXRpbGl6aW5nIHRoZSBjb25uZWN0b3IgZWZmZWN0aXZlbHksIGRldmVsb3BlcnMgY2FuIHN0cmVhbWxpbmUgZmlsZS1yZWxhdGVkIHdvcmtmbG93cyBhbmQgZW5oYW5jZSB0aGUgZnVuY3Rpb25hbGl0eSBvZiB0aGVpciBhcHBsaWNhdGlvbnMuIFdpdGggcHJvcGVyIGNvbmZpZ3VyYXRpb24gYW5kIGludGVncmF0aW9uLCB0aGUgRmlsZSBVcGxvYWQgQ29ubmVjdG9yIGNhbiBzaWduaWZpY2FudGx5IGltcHJvdmUgdGhlIGVmZmljaWVuY3kgYW5kIHVzYWJpbGl0eSBvZiBmaWxlIG1hbmFnZW1lbnQgdGFza3MgaW4geW91ciBhcHBsaWNhdGlvbiBlY29zeXN0ZW0uCg==",
  "ui_form": [
    {
      "field_id": "URL",
      "type": "string",
      "label": "File URL",
      "required": true,
      "description": "URL of the file",
      "ui_component": "fileInput",
      "info": "All the files that you need as context",
      "is_csv": false,
      "is_secret": false
    }
  ],
  "data_loaders": [
    {
      "name": "Process files",
      "description": "Processes all the files that are uploaded as a part of this connector",
      "sort": "pull",
      "logo": "https://klotdev.blob.core.windows.net/connectors/file_upload.png",
      "category": "file_upload",
      "endpoint": "/file_upload/pull",
      "is_enabled": true
    }
  ],
  "actions": [],
  "data_loader_config": {
    "start_time": "2025-04-21 09:13:56",
    "end_time": "2025-04-21 09:13:59"
  },
  "price": 0,
  "is_configured": true,
  "is_starred": false,
  "is_deleted": false,
  "triggers": [],
  "available_events": [],
  "is_premium": false,
  "data_to_verify": {
    "account_id": null,
    "url": null,
    "redirect_to_configuration": false,
    "type": null,
    "username": null
  },
  "coworker_metadata": null
}

Request

Path Params
projectID
string 
required
file_id
string 
required
Header Params
x-api-key
string 
required
Example:
{{x-api-key}}

Responses

🟢200get connector by fileid
application/json
Body
_id
string 
required
name
string 
required
description
string 
required
category
string 
required
status
string 
required
connector_type
string 
required
connector_group_tag
null 
required
user_id
null 
required
org_id
string 
required
projectID
string 
required
config
object 
required
fileIDs
array[string]
required
tags
array[string]
required
logo
string 
required
readme_b64
string 
required
ui_form
array [object {9}] 
required
field_id
string 
optional
type
string 
optional
label
string 
optional
required
boolean 
optional
description
string 
optional
ui_component
string 
optional
info
string 
optional
is_csv
boolean 
optional
is_secret
boolean 
optional
data_loaders
array [object {7}] 
required
name
string 
optional
description
string 
optional
sort
string 
optional
logo
string 
optional
category
string 
optional
endpoint
string 
optional
is_enabled
boolean 
optional
actions
array
required
data_loader_config
object 
required
start_time
string 
required
end_time
string 
required
price
integer 
required
is_configured
boolean 
required
is_starred
boolean 
required
is_deleted
boolean 
required
triggers
array
required
available_events
array
required
is_premium
boolean 
required
data_to_verify
object 
required
account_id
null 
required
url
null 
required
redirect_to_configuration
boolean 
required
type
null 
required
username
null 
required
coworker_metadata
null 
required
Modified at 2025-04-25 11:08:14
Previous
get files by fileid
Next
get files by connector_id