{"openapi":"3.1.0","info":{"title":"UMLS (BYOK) API","version":"0.1.0","description":"UMLS (BYOK) lets an AI assistant read your own UMLS data through the UMLS API with a key you supply (UMLS Terminology Services API key). Read-only: 7 tools (search_terms, get_concept, list_concept_definitions, list_concept_atoms, list_concept_relations, get_atom, get_semantic_type). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-umls.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-umls/docs"},"termsOfService":"https://connectorbay.com/byok-umls/terms"},"servers":[{"url":"https://byok-umls.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-umls/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/search_terms":{"post":{"operationId":"search_terms","summary":"Search UMLS for concepts or source vocabulary codes by term or code; returns concept ids (CUIs) or codes with names, sou","description":"Search UMLS for concepts or source vocabulary codes by term or code; returns concept ids (CUIs) or codes with names, source and semantic types (one page, up to 200). Use for \"Which UMLS concepts match 'fracture of carpal bone'\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"string":{"description":"A term such as 'gestational diabetes' or a code from a source vocabulary such as '9468002'.","maxLength":300,"title":"String","type":"string"},"input_type":{"anyOf":[{"enum":["atom","code","sourceConcept","sourceDescriptor","sourceUi","tty"],"type":"string"},{"type":"null"}],"default":null,"description":"What string is: atom (default), code, sourceConcept, sourceDescriptor, sourceUi or tty.","title":"Input Type"},"search_type":{"anyOf":[{"enum":["words","exact","leftTruncation","rightTruncation","normalizedString","normalizedWords"],"type":"string"},{"type":"null"}],"default":null,"description":"Matching: words (default), exact, leftTruncation, rightTruncation, normalizedString or normalizedWords.","title":"Search Type"},"return_id_type":{"anyOf":[{"enum":["concept","code","sourceConcept","sourceDescriptor","sourceUi","aui"],"type":"string"},{"type":"null"}],"default":null,"description":"What to return: concept (default, CUIs), code, sourceConcept, sourceDescriptor, sourceUi or aui.","title":"Return Id Type"},"sabs":{"anyOf":[{"maxLength":120,"type":"string"},{"type":"null"}],"default":null,"description":"Comma-separated source vocabulary abbreviations to include, for example 'SNOMEDCT_US,ICD10CM'; default all.","title":"Sabs"},"semantic_types":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Pipe-separated semantic type TUIs, names or tree-number prefixes, for example 'T047|T046'.","title":"Semantic Types"},"semantic_groups":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"A semantic group name such as 'Disorders' or 'Chemicals & Drugs'.","title":"Semantic Groups"},"page_size":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"Results to return (1 to 200, default 25); pagination is not supported on search.","title":"Page Size"}},"required":["string"],"title":"search_termsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_concept":{"post":{"operationId":"get_concept","summary":"Get one UMLS concept by CUI: name, status, semantic types, and counts of atoms, attributes and relations. Use for \"Descr","description":"Get one UMLS concept by CUI: name, status, semantic types, and counts of atoms, attributes and relations. Use for \"Describe UMLS concept C0009044\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"cui":{"description":"UMLS concept unique identifier, for example 'C0009044'.","maxLength":200,"title":"Cui","type":"string"}},"required":["cui"],"title":"get_conceptArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_concept_definitions":{"post":{"operationId":"list_concept_definitions","summary":"List the source-asserted definitions of a concept, with the vocabulary each comes from. Use for \"What definitions does U","description":"List the source-asserted definitions of a concept, with the vocabulary each comes from. Use for \"What definitions does UMLS give for concept C0155502\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"cui":{"description":"UMLS concept id, for example 'C0155502'.","maxLength":200,"title":"Cui","type":"string"},"sabs":{"anyOf":[{"maxLength":120,"type":"string"},{"type":"null"}],"default":null,"description":"Comma-separated source vocabulary abbreviations to include, for example 'SNOMEDCT_US,ICD10CM'; default all.","title":"Sabs"},"page_number":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page Number"},"page_size":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"Results per page (1 to 200, default 25).","title":"Page Size"}},"required":["cui"],"title":"list_concept_definitionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_concept_atoms":{"post":{"operationId":"list_concept_atoms","summary":"List the atoms (names in individual source vocabularies, with term type, language and code) of a concept; one page of up","description":"List the atoms (names in individual source vocabularies, with term type, language and code) of a concept; one page of up to 200. Use for \"Which source terms map to UMLS concept C0155502\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"cui":{"description":"UMLS concept id, for example 'C0155502'.","maxLength":200,"title":"Cui","type":"string"},"sabs":{"anyOf":[{"maxLength":120,"type":"string"},{"type":"null"}],"default":null,"description":"Comma-separated source vocabulary abbreviations to include, for example 'SNOMEDCT_US,ICD10CM'; default all.","title":"Sabs"},"ttys":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Comma-separated term types to keep, for example 'PT' for preferred terms.","title":"Ttys"},"language":{"anyOf":[{"maxLength":3,"type":"string"},{"type":"null"}],"default":null,"description":"Three-letter language code such as ENG.","title":"Language"},"page_size":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Results to return (1 to 200, default 50); pagination is not supported on atoms.","title":"Page Size"}},"required":["cui"],"title":"list_concept_atomsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_concept_relations":{"post":{"operationId":"list_concept_relations","summary":"List relationships of a concept to other concepts or source terms (broader, narrower, related), with labels and related ","description":"List relationships of a concept to other concepts or source terms (broader, narrower, related), with labels and related names. Use for \"What is UMLS concept C0009044 related to\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"cui":{"description":"UMLS concept unique identifier, for example 'C0009044'.","maxLength":200,"title":"Cui","type":"string"},"sabs":{"anyOf":[{"maxLength":120,"type":"string"},{"type":"null"}],"default":null,"description":"Comma-separated source vocabulary abbreviations to include, for example 'SNOMEDCT_US,ICD10CM'; default all.","title":"Sabs"},"include_relation_labels":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Comma-separated relation labels to keep, for example 'PAR,CHD'.","title":"Include Relation Labels"},"page_number":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page Number"},"page_size":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Results per page (1 to 200, default 50).","title":"Page Size"}},"required":["cui"],"title":"list_concept_relationsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_atom":{"post":{"operationId":"get_atom","summary":"Get one atom by its atom unique identifier (AUI): name, source vocabulary, term type, language and code. Use for \"Descri","description":"Get one atom by its atom unique identifier (AUI): name, source vocabulary, term type, language and code. Use for \"Describe UMLS atom A8345234\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"aui":{"description":"UMLS atom identifier, for example 'A8345234'.","maxLength":200,"title":"Aui","type":"string"}},"required":["aui"],"title":"get_atomArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_semantic_type":{"post":{"operationId":"get_semantic_type","summary":"Get a UMLS semantic type by its TUI: name, definition, tree number and semantic group. Use for \"What is UMLS semantic ty","description":"Get a UMLS semantic type by its TUI: name, definition, tree number and semantic group. Use for \"What is UMLS semantic type T109\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"tui":{"description":"Semantic type identifier, for example 'T109'.","maxLength":200,"title":"Tui","type":"string"}},"required":["tui"],"title":"get_semantic_typeArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}