Old OpenAlex API documentation
  • Overview
  • Quickstart tutorial
  • API Entities
    • Entities overview
    • đź“„Works
      • Work object
        • Authorship object
        • Location object
      • Get a single work
      • Get lists of works
      • Filter works
      • Search works
      • Group works
      • Get N-grams
    • đź‘©Authors
      • Author object
      • Get a single author
      • Get lists of authors
      • Filter authors
      • Search authors
      • Group authors
      • Limitations
      • Author disambiguation
    • 📚Sources
      • Source object
      • Get a single source
      • Get lists of sources
      • Filter sources
      • Search sources
      • Group sources
    • 🏫Institutions
      • Institution object
      • Get a single institution
      • Get lists of institutions
      • Filter institutions
      • Search institutions
      • Group institutions
    • đź’ˇTopics
      • Topic object
      • Get a single topic
      • Get lists of topics
      • Filter topics
      • Search topics
      • Group topics
    • 🗝️Keywords
    • 🏢Publishers
      • Publisher object
      • Get a single publisher
      • Get lists of publishers
      • Filter publishers
      • Search publishers
      • Group publishers
    • đź’°Funders
      • Funder object
      • Get a single funder
      • Get lists of funders
      • Filter funders
      • Search funders
      • Group funders
    • 🌎Geo
      • Continents
      • Regions
    • đź’ˇConcepts
      • Concept object
      • Get a single concept
      • Get lists of concepts
      • Filter concepts
      • Search concepts
      • Group concepts
    • Aboutness endpoint (/text)
  • How to use the API
    • API Overview
    • Get single entities
      • Random result
      • Select fields
    • Get lists of entities
      • Paging
      • Filter entity lists
      • Search entities
      • Sort entity lists
      • Select fields
      • Sample entity lists
      • Autocomplete entities
    • Get groups of entities
    • Rate limits and authentication
  • Download all data
    • OpenAlex snapshot
    • Snapshot data format
    • Download to your machine
    • Upload to your database
      • Load to a data warehouse
      • Load to a relational database
        • Postgres schema diagram
  • Additional Help
    • Tutorials
    • Report bugs
    • FAQ
Powered by GitBook
On this page
  1. API Entities

Aboutness endpoint (/text)

PreviousGroup conceptsNextAPI Overview

Last updated 10 months ago

You can use the /text API endpoint to tag your own free text with OpenAlex's "aboutness" assignments—topics, keywords, and concepts.

Accepts a title and optional abstract in the GET params or as a POST request. The results are straight from the model, with 0 values truncated.

Examples

  • Get OpenAlex for your text

  • Get OpenAlex for your text

  • Get OpenAlex for your text

  • Get all of the above in one request

Example response for that last one:

{
	meta: {
		keywords_count: 5,
		topics_count: 3,
		concepts_count: 3
	},
	keywords: [
		id: "https://openalex.org/keywords/type-1-diabetes",
		display_name: "Type 1 Diabetes",
		score: 0.677
	], ...
	primary_topic: {
		id: "https://openalex.org/T10560",
		display_name: "Management of Diabetes Mellitus and Hypoglycemia",
		score: 0.995
		// more information about the primary topic, removed for brevity
	},
	topics: [
		// list of topic objects with scores
	],
	concepts: [
		// list of concept objects with scores
	]
}

Queries are limited to between 20 and 2000 characters. The endpoints are rate limited to 1 per second and 1000 requests per day.

Keywords
https://api.openalex.org/text/keywords?title=type%201%20diabetes%20research%20for%20children
Topics
https://api.openalex.org/text/topics?title=type%201%20diabetes%20research%20for%20children
Concepts
https://api.openalex.org/text/concepts?title=type%201%20diabetes%20research%20for%20children
https://api.openalex.org/text?title=type%201%20diabetes%20research%20for%20children