GET /vector_stores/{vector_store_id}/file_batches/{batch_id}/files

Servers

Path parameters

Name Type Required Description
vector_store_id String Yes

The ID of the vector store that the files belong to.

batch_id String Yes

The ID of the file batch that the files belong to.

Query parameters

Name Type Required Description
order String No

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

Possible values:

  • "desc"
  • "asc"

Default value: "desc"

limit Integer No

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

Default value: 20

filter String No

Filter by file status. One of in_progress, completed, failed, cancelled.

Possible values:

  • "failed"
  • "in_progress"
  • "completed"
  • "cancelled"
after String No

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.

before String No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.