Skip to main content
POST
Create folder

Authorizations

Authorization
string
header
required

API token from cargo-ai login. Send as Authorization: Bearer <token>.

Headers

Idempotency-Key
string

Client-generated key that makes this write safe to retry. Reusing the same key with the same request returns the original response instead of creating a second record. Reusing it with a different request returns 422. A concurrent retry while the first request is still running returns 409. Keys expire after 24 hours. Not accepted on multipart file uploads. Optional: a request without one is processed as it always was.

Maximum string length: 255
Example:

"8e03978e-40d5-43e8-bc93-6894a57f9324"

Body

application/json

Request body schema.

name
string
required

Folder name.

Required string length: 1 - 255
emojiSlug
string
required

Emoji shown next to the folder name.

Required string length: 1 - 32
kind
enum<string>
required

Folder kind, such as file or play.

Available options:
play,
tool,
agent,
file,
mcpServer,
model,
app,
worker,
alert,
mailbox
parentUuid
string<uuid>

Parent folder identifier. Omit to create a root folder.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

Response

Create folder

folder
object
required