# Mink API v3 — Bring Your Own Corpus

**Canonical:** https://apis.io/apis/university-of-gothenburg/mink-api/  
**Provider:** University of Gothenburg — https://apis.io/providers/university-of-gothenburg/  
**Base URL:** https://ws.spraakbanken.gu.se/ws/mink/v3  
**Documentation:** https://ws.spraakbanken.gu.se/docs/mink

Mink API v3 — Bring Your Own Corpus is one of 14 APIs that [University of Gothenburg](https://apis.io/providers/university-of-gothenburg/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Language Technology, Corpus Linguistics, Research Data, Annotation, and Upload. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

Mink lets a researcher upload their own text, run it through the Sparv annotation pipeline and publish it into Korp. Sixty-three paths, the largest contract in this profile and the only one with a real authorisation model — an OAuth2 bearer scheme plus an API-key header, whose accounts are federated logins riding on the same SWAMID/eduGAIN infrastructure the University operates its own IdP inside of. Institution-operated: servers ws.spraakbanken.gu.se production and dev, contact sb-info@svenska.gu.se, MIT licence. Verified live 2026-09-01: anonymous GET /info returned HTTP 200 with the job status-code catalogue.

## Operations (60 of 63)

| Method | Path | Summary |
|---|---|---|
| GET | `/docs` | Docs |
| GET | `/openapi.json` | Openapi |
| GET | `/redoc` | Redoc |
| GET | `/swagger` | Swagger |
| GET | `/info` | Info |
| GET | `/return-codes` | List Return Codes |
| PUT | `/queue/advance` | Advance Queue |
| GET | `/queue/health` | Queue Health |
| GET | `/resource/list` | List Resources |
| GET | `/resource/status/list` | List Resource Statuses |
| GET | `/resource/status/get/{resource_id}` | Get Resource Status |
| POST | `/user/admin-mode/activate` | Activate Admin Mode |
| POST | `/admin-mode-on` | Admin-Mode-On-Deprecated |
| POST | `/user/admin-mode/deactivate` | Deactivate Admin Mode |
| POST | `/admin-mode-off` | Admin-Mode-Off-Deprecated |
| GET | `/admin-mode-status` | Admin Mode Status |
| GET | `/user/info/get` | Get User Info |
| GET | `/corpus/sparv/get-schema` | Sparv Schema |
| GET | `/corpus/sparv/list-languages` | Sparv Languages |
| GET | `/corpus/sparv/list-exports` | Sparv Exports |
| POST | `/corpus/create` | Create Corpus |
| GET | `/corpus/list` | List Corpora |
| GET | `/corpus/korp/list` | List Korp Corpora |
| GET | `/list-korp-corpora` | List-Korp-Corpora-Deprecated |
| DELETE | `/corpus/remove/{resource_id}` | Remove Corpus |
| PUT | `/corpus/sources/upload/{resource_id}` | Upload Sources |
| GET | `/corpus/sources/list/{resource_id}` | List Sources |
| DELETE | `/corpus/sources/remove/{resource_id}` | Remove Sources |
| GET | `/corpus/sources/download/{resource_id}` | Download Sources |
| PUT | `/corpus/config/upload/{resource_id}` | Upload Config |
| GET | `/corpus/config/download/{resource_id}` | Download Config |
| GET | `/corpus/exports/list/{resource_id}` | List Exports |
| GET | `/corpus/exports/download/{resource_id}` | Download Exports |
| DELETE | `/corpus/exports/remove/{resource_id}` | Remove Exports |
| GET | `/corpus/job/check-input/{resource_id}` | Check Input |
| PUT | `/corpus/job/run/{resource_id}` | Run Sparv |
| POST | `/corpus/job/abort/{resource_id}` | Abort Job |
| DELETE | `/corpus/annotations/remove/{resource_id}` | Clear Annotations |
| PUT | `/corpus/korp/install/{resource_id}` | Install Korp |
| DELETE | `/corpus/korp/uninstall/{resource_id}` | Uninstall Korp |
| PUT | `/corpus/strix/install/{resource_id}` | Install Strix |
| DELETE | `/corpus/strix/uninstall/{resource_id}` | Uninstall Strix |
| POST | `/metadata/create` | Create Metadata |
| DELETE | `/metadata/remove/{resource_id}` | Remove Metadata |
| GET | `/metadata/list` | List Metadata |
| PUT | `/metadata/config/upload/{resource_id}` | Upload Metadata Yaml |
| GET | `/metadata/config/download/{resource_id}` | Download Metadata Yaml |
| POST | `/lexicon/create` | Create Lexicon |
| GET | `/lexicon/list` | List Lexicons |
| DELETE | `/lexicon/remove/{resource_id}` | Remove Lexicon |
| PUT | `/lexicon/sources/upload/{resource_id}` | Upload Sources |
| GET | `/lexicon/sources/list/{resource_id}` | List Sources |
| DELETE | `/lexicon/sources/remove/{resource_id}` | Remove Sources |
| GET | `/lexicon/sources/download/{resource_id}` | Download Sources |
| PUT | `/lexicon/config/upload/{resource_id}` | Upload Config |
| GET | `/lexicon/config/download/{resource_id}` | Download Config |
| GET | `/lexicon/exports/list/{resource_id}` | List Exports |
| GET | `/lexicon/exports/download/{resource_id}` | Download Exports |
| DELETE | `/lexicon/exports/remove/{resource_id}` | Remove Exports |
| PUT | `/lexicon/job/run/{resource_id}` | Run Karp Pipeline |

…and 3 more operations. They are listed in full on the page.

## Machine-readable artifacts (4)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/university-of-gothenburg/refs/heads/main/openapi/university-of-gothenburg-mink-api-openapi.yml
- **Documentation** — https://ws.spraakbanken.gu.se/docs/mink
- **Examples** — https://raw.githubusercontent.com/api-evangelist/university-of-gothenburg/refs/heads/main/examples/university-of-gothenburg-mink-info-example.json
- **Authentication** — https://raw.githubusercontent.com/api-evangelist/university-of-gothenburg/refs/heads/main/authentication/university-of-gothenburg-authentication.yml

## Other University of Gothenburg APIs (12)

- [Korp API v8 — Corpus Concordance Search](https://apis.io/apis/university-of-gothenburg/korp-api/)
- [Språkbanken Text Metadata API v3](https://apis.io/apis/university-of-gothenburg/sbx-metadata-api/)
- [Sparv API v3 — Text Annotation Pipeline](https://apis.io/apis/university-of-gothenburg/sparv-api/)
- [Karp API v7 — Lexical Resource Editing](https://apis.io/apis/university-of-gothenburg/karp-api/)
- [Karp Search API v1 — Karps sökgränssnitt](https://apis.io/apis/university-of-gothenburg/karp-search-api/)
- [GUPEA Repository OAI-PMH 2.0 Interface](https://apis.io/apis/university-of-gothenburg/gupea-oai-pmh/)
- [GUPEA DSpace 8 REST API](https://apis.io/apis/university-of-gothenburg/gupea-dspace-rest/)
- [Shibboleth Identity Provider — SAML 2.0 Metadata](https://apis.io/apis/university-of-gothenburg/shibboleth-idp/)
- [Microsoft AD FS Identity Provider (SWAMID entity)](https://apis.io/apis/university-of-gothenburg/adfs-idp/)
- [DataCite DOI Registration (client SND.SPRKB, via the Swedish National Data Service)](https://apis.io/apis/university-of-gothenburg/datacite-registration/)
- [Crossref Membership (members 36737 and 51378)](https://apis.io/apis/university-of-gothenburg/crossref-membership/)
- [Quality of Government (QoG) Open Data](https://apis.io/apis/university-of-gothenburg/qog-data/)

## Tags

Language Technology, Corpus Linguistics, Research Data, Annotation, Upload

---

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