# Spoolman API

**Canonical:** https://apis.io/apis/spoolman/spoolman-api/  
**Provider:** Spoolman — https://apis.io/providers/spoolman/  
**Base URL:** https://octoeverywhere.com  
**Documentation:** https://docs.octoeverywhere.com/app-connections/apis/info-api

Spoolman API is one of 2 APIs that [Spoolman](https://apis.io/providers/spoolman/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Spoolman API as documented publicly: 12 operations. Contract generated from the documentation by API Evangelist (2026-10-28); not the provider's own document.

## Operations (12)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/appconnection/DeleteNotificationWebhook` | Deletes the App Connection webhook notification URL to prevent future callbacks. |
| POST | `/api/appconnection/SetNotificationWebhook` | Sets or updates the App Connection notification webhook URL. |
| GET | `/api/appconnection/TestWebhook` | App developers can easily invoke test webhook calls from the OctoEverywhere service to the configured WebhookUrl using this test API. |
| GET | `/api/appconnection/info` | Returns current state and useful details for one App Connection. |
| POST | `/api/gadget/GetStatusFromAppConnection` | Returns the current state of Gadget, OctoEverywhere's AI failure detection assistant, for the printer associated with an App Connection. |
| POST | `/api/gadget/v1/cancelcontext/{id}` | Close a context early. |
| POST | `/api/gadget/v1/contextinfo/{id}` | Read the context's current settings and state. |
| POST | `/api/gadget/v1/createcontext` | POST /api/gadget/v1/createcontext |
| POST | `/api/gadget/v1/extendcontext/{id}` | Extend a context's lifetime when a print needs more time. |
| POST | `/api/live/createfromappconnection` | The Create Live Link API creates a shareable Live Link for the printer associated with an App Connection. |
| GET | `/appportal/v1` | Start the App Connection Portal for app setup. |
| GET | `/appportal/v1/complete` | Default completion URL for the App Connection Portal where the portal navigates upon setup success or failure. |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/spoolman/openapi/_ae-authored/spoolman-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/spoolman/json-schema/spoolman-get-api-appconnection-info-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/spoolman/json-schema/spoolman-post-api-gadget-v1-contextinfo-id-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/spoolman/json-schema/spoolman-post-api-appconnection-setnotificationwebhook-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/spoolman/json-schema/spoolman-post-api-live-createfromappconnection-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/spoolman/json-schema/spoolman-post-api-gadget-getstatusfromappconnection-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/spoolman/json-schema/spoolman-post-api-gadget-v1-extendcontext-id-response-schema.json

## Other Spoolman APIs (1)

- [Spoolman API](https://apis.io/apis/spoolman/spoolman-api-2/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/spoolman/spoolman-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/spoolman/.