/api/agent

POST /api/agent/v1/collection

Changed on

Create a new Collection.

Pass parent_collection_id to nest under another collection; omit for a root-level collection. The caller must have write access to the parent (or root, if no parent given).

post/api/agent/v1/collection

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-API-Key

Request body

descriptionstring nullable
namestring required

value must be a non-blank string.

parent_collection_idinteger nullable

value must be an integer greater than zero.

Response

Successful response

descriptionstring nullable required
idinteger required

value must be an integer greater than zero.

locationstring required

value must be a non-blank string.

namestring required

value must be a non-blank string.

parent_idinteger nullable required

value must be an integer greater than zero.

Changes