83 lines
2.4 KiB
Markdown
83 lines
2.4 KiB
Markdown
---
|
|
name: blocks-routes
|
|
description: Handle 8 OpenAPI operation(s) under /api/v1/blocks for the blocks route group.
|
|
---
|
|
|
|
# blocks API Routes
|
|
|
|
Handle 8 OpenAPI operation(s) under /api/v1/blocks for the blocks 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
|
|
|
|
### api_get_audio_file_block_api_v1_blocks_audio_get
|
|
|
|
- Operation ID: `api_get_audio_file_block_api_v1_blocks_audio_get`
|
|
- Route: `GET /api/v1/blocks/audio`
|
|
- Mode: READ
|
|
- Summary: Get audio block
|
|
- Parameters:
|
|
- `block_uuid` in `query` required
|
|
|
|
### api_create_audio_file_block_api_v1_blocks_audio_post
|
|
|
|
- Operation ID: `api_create_audio_file_block_api_v1_blocks_audio_post`
|
|
- Route: `POST /api/v1/blocks/audio`
|
|
- Mode: WRITE
|
|
- Summary: Create audio block
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_get_image_file_block_api_v1_blocks_image_get
|
|
|
|
- Operation ID: `api_get_image_file_block_api_v1_blocks_image_get`
|
|
- Route: `GET /api/v1/blocks/image`
|
|
- Mode: READ
|
|
- Summary: Get image block
|
|
- Parameters:
|
|
- `block_uuid` in `query` required
|
|
|
|
### api_create_image_file_block_api_v1_blocks_image_post
|
|
|
|
- Operation ID: `api_create_image_file_block_api_v1_blocks_image_post`
|
|
- Route: `POST /api/v1/blocks/image`
|
|
- Mode: WRITE
|
|
- Summary: Create image block
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_get_pdf_file_block_api_v1_blocks_pdf_get
|
|
|
|
- Operation ID: `api_get_pdf_file_block_api_v1_blocks_pdf_get`
|
|
- Route: `GET /api/v1/blocks/pdf`
|
|
- Mode: READ
|
|
- Summary: Get PDF block
|
|
- Parameters:
|
|
- `block_uuid` in `query` required
|
|
|
|
### api_create_pdf_file_block_api_v1_blocks_pdf_post
|
|
|
|
- Operation ID: `api_create_pdf_file_block_api_v1_blocks_pdf_post`
|
|
- Route: `POST /api/v1/blocks/pdf`
|
|
- Mode: WRITE
|
|
- Summary: Create PDF block
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_get_video_file_block_api_v1_blocks_video_get
|
|
|
|
- Operation ID: `api_get_video_file_block_api_v1_blocks_video_get`
|
|
- Route: `GET /api/v1/blocks/video`
|
|
- Mode: READ
|
|
- Summary: Get video block
|
|
- Parameters:
|
|
- `block_uuid` in `query` required
|
|
|
|
### api_create_video_file_block_api_v1_blocks_video_post
|
|
|
|
- Operation ID: `api_create_video_file_block_api_v1_blocks_video_post`
|
|
- Route: `POST /api/v1/blocks/video`
|
|
- Mode: WRITE
|
|
- Summary: Create video block
|
|
- Body: JSON request body accepted.
|