REST: List files

Returns a list of files.

HTTP request

GET https://ai.api.cloud.yandex.net/v1/files

Query parameters

Field

Description

purpose

string

Only return files with the given purpose.

limit

integer

A limit on the number of objects to be returned. Limit can range between 1 and 10,000, and the default is 10,000.

order

enum

Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.

  • asc
  • desc

after

string

A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

Response

HTTP Code: 200

OK

Response schema: application/json

{
          "object": "string",
          "data": [
            {
              "id": "string",
              "bytes": "integer",
              "created_at": "integer",
              "expires_at": "integer",
              "filename": "string",
              "object": "string",
              "purpose": "string",
              "status": "string",
              "status_details": "string"
            }
          ],
          "first_id": "string",
          "last_id": "string",
          "has_more": "boolean"
        }

Field

Description

object

string

Required field.

data[]

unknown

Required field. The File object represents a document that has been uploaded to Yandex Cloud AI Studio.

first_id

string

Required field.

last_id

string

Required field.

has_more

boolean

Required field.
Предыдущая
Overview
Следующая
createFile