49 lines
1.2 KiB
Markdown
49 lines
1.2 KiB
Markdown
---
|
|
name: files-routes
|
|
description: Handle 3 OpenAPI operation(s) under /v1/files for the files route group.
|
|
---
|
|
|
|
# files API Routes
|
|
|
|
Handle 3 OpenAPI operation(s) under /v1/files for the files route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### get_files
|
|
|
|
- Operation ID: `get_files`
|
|
- Route: `GET /v1/files`
|
|
- Mode: READ
|
|
- Summary: List all files
|
|
- Parameters:
|
|
- `created` in `query`
|
|
- `ending_before` in `query`
|
|
- `expand` in `query`
|
|
- `limit` in `query`
|
|
- `purpose` in `query`
|
|
- `starting_after` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_files
|
|
|
|
- Operation ID: `post_files`
|
|
- Route: `POST /v1/files`
|
|
- Mode: WRITE
|
|
- Summary: Create a file
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_files_file
|
|
|
|
- Operation ID: `get_files_file`
|
|
- Route: `GET /v1/files/{file}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a file
|
|
- Parameters:
|
|
- `expand` in `query`
|
|
- `file` in `path` required
|
|
- Body: JSON request body accepted.
|