agent-swarm.devagent-swarm.dev

FS

FS API endpoints

POST
/api/fs/agent-credentials

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/fs/agent-credentials" \  -H "Content-Type: application/json" \  -d '{}'
{
  "enabled": true,
  "created": true,
  "agentId": "string",
  "email": "string",
  "orgId": "string",
  "driveId": "string"
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
GET
/api/fs/capabilities

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Response Body

application/json

application/json

curl -X GET "http://localhost:3013/api/fs/capabilities"
{
  "providerId": "string",
  "capabilities": {
    "signedUrl": {
      "supported": true,
      "maxExpiresIn": 0
    },
    "search": true,
    "comments": true,
    "versioning": true
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
POST
/api/fs/members/invite

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/fs/members/invite" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com"  }'
{
  "orgId": "string",
  "invited": true
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
GET
/api/fs/tasks/{taskId}/files

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

taskId*string
Formatuuid

Response Body

application/json

application/json

curl -X GET "http://localhost:3013/api/fs/tasks/497f6eca-6276-4993-bfeb-53cbbbba6f08/files"
{
  "attachments": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
      "agentId": "string",
      "name": "string",
      "kind": "agent-fs",
      "url": "string",
      "path": "string",
      "pageId": "string",
      "providerId": "string",
      "providerKey": "string",
      "capabilities": {
        "property1": null,
        "property2": null
      },
      "orgId": "string",
      "driveId": "string",
      "mimeType": "string",
      "sizeBytes": 0,
      "sha256": "string",
      "intent": "string",
      "description": "string",
      "isPrimary": false,
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "updatedBy": "string"
    }
  ]
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
POST
/api/fs/tasks/{taskId}/files

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

taskId*string
Formatuuid

Query Parameters

name*string
Length1 <= length
intent?string
description?string
isPrimary?string
Value in"true" | "false"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/fs/tasks/497f6eca-6276-4993-bfeb-53cbbbba6f08/files?name=string"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  "agentId": "string",
  "name": "string",
  "kind": "agent-fs",
  "url": "string",
  "path": "string",
  "pageId": "string",
  "providerId": "string",
  "providerKey": "string",
  "capabilities": {
    "property1": null,
    "property2": null
  },
  "orgId": "string",
  "driveId": "string",
  "mimeType": "string",
  "sizeBytes": 0,
  "sha256": "string",
  "intent": "string",
  "description": "string",
  "isPrimary": false,
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "updatedBy": "string"
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
DELETE
/api/fs/tasks/{taskId}/files/{attachmentId}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

taskId*string
Formatuuid
attachmentId*string
Formatuuid

Response Body

application/json

application/json

curl -X DELETE "http://localhost:3013/api/fs/tasks/497f6eca-6276-4993-bfeb-53cbbbba6f08/files/497f6eca-6276-4993-bfeb-53cbbbba6f08"
Empty
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
GET
/api/fs/tasks/{taskId}/files/{attachmentId}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

taskId*string
Formatuuid
attachmentId*string
Formatuuid

Response Body

application/json

application/json

curl -X GET "http://localhost:3013/api/fs/tasks/497f6eca-6276-4993-bfeb-53cbbbba6f08/files/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  "agentId": "string",
  "name": "string",
  "kind": "agent-fs",
  "url": "string",
  "path": "string",
  "pageId": "string",
  "providerId": "string",
  "providerKey": "string",
  "capabilities": {
    "property1": null,
    "property2": null
  },
  "orgId": "string",
  "driveId": "string",
  "mimeType": "string",
  "sizeBytes": 0,
  "sha256": "string",
  "intent": "string",
  "description": "string",
  "isPrimary": false,
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "updatedBy": "string"
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
GET
/api/fs/tasks/{taskId}/files/{attachmentId}/raw

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

taskId*string
Formatuuid
attachmentId*string
Formatuuid

Response Body

application/json

curl -X GET "http://localhost:3013/api/fs/tasks/497f6eca-6276-4993-bfeb-53cbbbba6f08/files/497f6eca-6276-4993-bfeb-53cbbbba6f08/raw"
Empty
{
  "error": "string",
  "property1": null,
  "property2": null
}
GET
/api/fs/tasks/{taskId}/files/{attachmentId}/signed-url

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

taskId*string
Formatuuid
attachmentId*string
Formatuuid

Query Parameters

expiresIn?integer
Range0 < value <= 3600

Response Body

application/json

application/json

application/json

curl -X GET "http://localhost:3013/api/fs/tasks/497f6eca-6276-4993-bfeb-53cbbbba6f08/files/497f6eca-6276-4993-bfeb-53cbbbba6f08/signed-url"
{
  "url": "string",
  "expiresIn": 0
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}

External APIs

External APIs API endpoints

Favorites

Favorites API endpoints