All Resources
GET
Get a block
/v3/blocks/{id}
GET
Get batch status
/v3/blocks/batch/{batch_id}
GET
Get block comments
/v3/blocks/{id}/comments
GET
Get block connections
/v3/blocks/{id}/connections
POST
Batch create blocks
/v3/blocks/batch
POST
Create a block
/v3/blocks
POST
Create a comment
/v3/blocks/{id}/comments
PUT
Update a block
/v3/blocks/{id}
Returns the current status of a batch block creation job. Poll this endpoint to track progress and retrieve results.
Batch results are available for 24 hours after submission.
⚠️ Premium Only: This endpoint requires a Premium subscription.
GET
https://api.are.na/v3/blocks/batch/{batch_id}
Current status of a batch processing job
batch_id
string (uuid)!
Unique identifier for this batch
status
string!
Current processing status
pendingprocessingcompletedfailed
total
integer!
Total number of blocks in the batch
successful_count
integer!
Number of blocks created so far
failed_count
integer!
Number of blocks that failed
successful
object[]
Successfully created blocks
[items]
object
index
integer!
Original index in the request array
block_id
integer!
ID of the created block
failed
object[]
Blocks that failed to create
[items]
object
index
integer!
Original index in the request array
error
string!
Error message
created_at
string (date-time)
When the batch was submitted
completed_at
string (date-time)
When the batch finished processing (present when completed or failed)
error
string
Top-level error message if the entire batch failed