# University of Gothenburg Analysis API **Canonical:** https://apis.io/apis/university-of-gothenburg/university-of-gothenburg-analysis-api/ **Provider:** University of Gothenburg — https://apis.io/providers/university-of-gothenburg/ **Base URL:** https://ws.spraakbanken.gu.se/ws/korp/v8 **Documentation:** https://ws.spraakbanken.gu.se/docs/korp University of Gothenburg Analysis API is one of 33 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. This API exposes 2 JSON Schema definitions. Tagged areas include Analysis. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 2 JSON Schemas. ### Queries for Annotating Texts The default query for the text analysis can be sent as GET or POST requests. The latter can be useful for longer texts. In both cases the response is a JSON object containing the text analysis in XML format. See [Default query](#tag/Analysis/paths/~1/get) for more details. It is also possible to upload text or XML files. In this case the response is a JSON object with a download link to a zip file containing the annotation. See [File upload](#tag/Files/paths/~1upload/post) for more details. ### Settings The web service supports some custom settings, e.g. it lets you choose between different tokenizers on word, sentence, and paragraph level and you can define which annotations should be generated. Via the settings you can also choose the language of your input and you can define whether your input is in XML or plain text. These settings are provided as a JSON object to the `settings` parameter. This object must satisfy the JSON schema that is generated by `/schema` call when provided with a `language` and a `mode` parameter: [`/schema?language=sv&mode=plain`](https://ws.spraakbanken.gu.se/ws/sparv/v3/schema?language=sv&mode=plain) The schema holds default values for all the attributes. The use of the settings parameter is therefore optional. This is an example for a request which only generates a dependency analysis: [`/?text=Det+trodde+jag+aldrig.&settings={"positional_attributes":{"dependency_attributes":["ref","dephead","deprel"],"lexical_attributes":[],"compound_attributes":[]}}`](https://ws.spraakbanken.gu.se/ws/sparv/v3/?text=Det+trodde+jag+aldrig.&settings={"positional_attributes":{"dependency_attributes":["ref","dephead","deprel"],"lexical_attributes":[],"compound_attributes":[]}}) If you are not sure how to define the settings parameter you can get help from the [frontend](https://spraakbanken.gu.se/sparv) by clicking `Show JSON Settings` under `Show advanced settings`. This will generate the JSON object for the chosen settings which is sent in the `settings` parameter. ### Analysing other Languages The default analysis language is Swedish but Sparv also supports other languages. The language is specified by supplying a two-letter ISO 639-1 code to the `language` parameter. This is an example for an analysis of a German sentence: [`/?text=Nun+folgt+ein+deutscher+Beispielsatz.&language=de`](https://ws.spraakbanken.gu.se/ws/sparv/v3/?text=Nun+folgt+ein+deutscher+Beispielsatz.&language=de) Different kinds of settings are supported for different languages, depending on which tool is used for the analysis. Please use the [frontend](https://spraakbanken.gu.se/sparv) if you want to check what options there are for a certain language. Alternatively you can check the JSON schema for the language you want to analyse by sending a schema request, e.g.: [`/schema?language=de`](https://ws.spraakbanken.gu.se/ws/sparv/v3/schema?language=de) [This language table](https://spraakbanken.gu.se/eng/research/infrastructure/sparv/distribution/pipeline#language_table) provides information on which languages are currently supported and which tools are used for their analysis. ## Operations (5) | Method | Path | Summary | |---|---|---| | GET | `/` | Default query | | POST | `/` | Default query | | GET | `/schema` | Schema | | GET | `/makefile` | Makefile | | GET | `/join` | Join | ## Machine-readable artifacts (17) - **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/university-of-gothenburg/refs/heads/main/openapi/university-of-gothenburg-analysis-api-openapi.yml - **Documentation** — https://ws.spraakbanken.gu.se/docs/korp - **Examples** — https://raw.githubusercontent.com/api-evangelist/university-of-gothenburg/refs/heads/main/examples/university-of-gothenburg-korp-info-example.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/university-of-gothenburg/refs/heads/main/json-schema/university-of-gothenburg-korp-info.json - **Documentation** — https://ws.spraakbanken.gu.se/docs/metadata - **Examples** — https://raw.githubusercontent.com/api-evangelist/university-of-gothenburg/refs/heads/main/examples/university-of-gothenburg-metadata-list-ids-example.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/university-of-gothenburg/refs/heads/main/json-schema/university-of-gothenburg-sbx-resource.json - **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 - **Documentation** — https://ws.spraakbanken.gu.se/docs/sparv - **Examples** — https://raw.githubusercontent.com/api-evangelist/university-of-gothenburg/refs/heads/main/examples/university-of-gothenburg-sparv-ping-example.json - **Documentation** — https://ws.spraakbanken.gu.se/docs/karp - **Documentation** — https://ws.spraakbanken.gu.se/docs/karp-s - **Examples** — https://raw.githubusercontent.com/api-evangelist/university-of-gothenburg/refs/heads/main/examples/university-of-gothenburg-karp-search-config-example.json - **Examples** — https://raw.githubusercontent.com/api-evangelist/university-of-gothenburg/refs/heads/main/examples/university-of-gothenburg-gupea-oai-identify-example.xml - **Vocabulary** — https://raw.githubusercontent.com/api-evangelist/university-of-gothenburg/refs/heads/main/vocabulary/university-of-gothenburg-oai-metadata-formats-vocabulary.yml ## Other University of Gothenburg APIs (12) - [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/) - [Microsoft 365 / Entra ID Tenancy (medarbetarportalen.gu.se)](https://apis.io/apis/university-of-gothenburg/microsoft-365-tenancy/) - [University of Gothenburg Cache management API](https://apis.io/apis/university-of-gothenburg/university-of-gothenburg-cache-management-api/) - [University of Gothenburg Cleanup API](https://apis.io/apis/university-of-gothenburg/university-of-gothenburg-cleanup-api/) - [University of Gothenburg Concordance API](https://apis.io/apis/university-of-gothenburg/university-of-gothenburg-concordance-api/) - [University of Gothenburg Config API](https://apis.io/apis/university-of-gothenburg/university-of-gothenburg-config-api/) - [University of Gothenburg Count API](https://apis.io/apis/university-of-gothenburg/university-of-gothenburg-count-api/) ## Tags Analysis --- Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/university-of-gothenburg/university-of-gothenburg-analysis-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/university-of-gothenburg/.