/

phenoml.comGet API keys →

Home Guides API reference

Reference

Introduction Errors Common headers

Getting started

POSTGenerate authentication token POSTRequest an access token

Understand

POSTSubmit feedback on extraction results GETList available code systems GETGet code system detail DELETEDelete custom code system GETExport custom code system POSTUpload custom code system GETList codes in a code system GETGet a specific code GETSemantic search (embedding-based)GETText search (keyword-based)POSTExtract medical codes from text

Structure

POSTAnalyze text for patient cohort criteria POSTCreate FHIR resource from text POSTExtract multiple FHIR resources from text POSTConvert document to FHIR resource POSTExtract multiple FHIR resources from a document POSTUpload custom FHIR profile POSTGenerate FHIR search parameters from text

POSTGenerate a summary from FHIR resources POSTCreate a new summary template GETGet a summary template by ID PUTUpdate a summary template DELETEDelete a summary template GETList all summary templates

POSTMap FHIR resources to OMOP CDM v5.4

Act

GETGet agent by ID PUTUpdate agent DELETEDelete agent PATCHPatch agent POSTCreate a new agent GETList agents POSTChat with agent GETGet chat messages POSTChat with agent (streaming)POSTCreate agent prompt GETGet prompt by ID PUTUpdate prompt DELETEDelete prompt PATCHPatch prompt GETList agent prompts

GETList all workflows POSTCreate new workflow GETGet workflow by ID PUTUpdate workflow DELETEDelete workflow POSTExecute workflow

POSTAnalyze patient cohorts POSTCreate FHIR resource from text and store it POSTExtract and store multiple FHIR resources POSTSearch FHIR resources from natural language GETGet MCP server by ID DELETEDelete MCP server by ID POSTCreate MCP server GETList MCP servers GETList MCP server tools GETGet MCP server tool by ID DELETEDelete MCP server tool by ID

Connect & store

POSTCreate FHIR provider GETGet FHIR provider by ID DELETEDelete FHIR provider POSTExecute FHIR bundle operation GETRead or search FHIR resources PUTUpsert FHIR resource POSTCreate FHIR resource DELETEDelete FHIR resource PATCHPatch FHIR resource GETList FHIR providers PATCHAdd authentication configuration PATCHRemove authentication configuration PATCHSet active authentication configuration

Other references

POSTTranscribe audio

Other references

Markdown index Full API export

Authentication

Manage API credentials, generate authentication tokens, and handle authorization.

Endpoints

POST/auth/tokenPOST/v2/auth/token