Upstream APIs¶
InvokeAI server API reference.
API Endpoints¶
Images¶
GET /api/v1/images/
- List imagesPOST /api/v1/images/upload
- Upload imageGET /api/v1/images/i/{name}
- Get imageDELETE /api/v1/images/i/{name}
- Delete image
Boards¶
GET /api/v1/boards/
- List boardsPOST /api/v1/boards/
- Create boardGET /api/v1/boards/{id}
- Get boardDELETE /api/v1/boards/{id}
- Delete board
Models¶
GET /api/v1/models/
- List modelsGET /api/v1/models/i/{key}
- Get model infoPOST /api/v1/models/load
- Load model
Queue¶
POST /api/v1/queue/default/enqueue_batch
- Submit batchGET /api/v1/queue/default/status
- Queue statusGET /api/v1/queue/default/session/{id}
- Session status
WebSocket Events¶
// Connection
ws://localhost:9090/ws
// Events
{
"event": "invocation_started",
"data": {...}
}
{
"event": "invocation_complete",
"data": {...}
}
{
"event": "session_complete",
"data": {...}
}
OpenAPI Specification¶
Full API spec available at:
- Development: http://localhost:9090/openapi.json
- Reference: context/hints/invokeai-kb/invokeai-openapi.json
Rate Limiting¶
- Default: 100 requests/minute
- Batch operations: 10 requests/minute
- WebSocket: 1 connection per client
See API Reference for client-side APIs.