List collection files

GET 
/api/v1/collections/:collection-id/files

List files of a given collection.

Request

Path Parameters

collection-id stringrequired

Collection ID

Responses

200

Successful response

application/json

Schema

Schema

result

object[]

required

List of files in the collection

Array [

id stringrequired

File ID

name stringrequired

File name

type stringrequired

File's MIME type

status stringrequired

Possible values: [pending, indexed, error]

File status

error stringnullable

Error message if the file indexing failed

created_at stringrequired

Timestamp when the file was created

user_id stringrequired

ID of creating user

url urirequired

File URL

size numbernullable

File size in bytes

md5_hash stringnullable

MD5 hash of the file

connector_id stringnullable

ID of the connector managing the file

]

Example (from schema)

{
  "result": [
    {
      "id": "string",
      "name": "string",
      "type": "string",
      "status": "pending",
      "error": "string",
      "created_at": "string",
      "user_id": "string",
      "url": "string",
      "size": 0,
      "md5_hash": "string",
      "connector_id": "string"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

error

object

required

message stringrequired

Human readable error message

data nullable

Further details on the error

Example (from schema)

{
  "error": {
    "message": "string"
  }
}

403

Forbidden

application/json

Schema

Schema

error

object

required

message stringrequired

Human readable error message

data nullable

Further details on the error

Example (from schema)

{
  "error": {
    "message": "string"
  }
}

404

Not found

application/json

Schema

Schema

error

object

required

message stringrequired

Human readable error message

data nullable

Further details on the error

Example (from schema)

{
  "error": {
    "message": "string"
  }
}

Loading...