Meridian API

Reference Processing Service with Edifix Integration

GET /api/v1/health No Auth Required

Description: Check API and database connectivity

Response (200 OK):

POST /api/v1/jobs Auth Required

Description: Create a new reference processing job

Request Headers:

• Authorization: Bearer <token>
• Typefi-Installation-Code: <installation_code>
• Content-Type: application/json

Request Body:

Note: For available edit_style values, see Available Edit Styles.

Required Fields:

• username (string) - User email address (max 256 characters)
• edifix-data.input_refs (string) - Reference text to process
• edifix-data.edit_style (string) - Citation style (see Available Edit Styles below)

Optional Fields (edifix-data):

• edifix-data.job_name (string) - Job name
• edifix-data.pubmed_flag (boolean) - Enable PubMed lookup
• edifix-data.crossref_flag (boolean) - Enable Crossref lookup
• edifix-data.run_cabells_flag (boolean) - Enable Cabells lookup
• edifix-data.remove_line_breaks_flag (boolean) - Remove line breaks from references
• edifix-data.book_processing_flag (boolean) - Enable book processing mode
• edifix-data.stylesheet_contents (string) - Custom stylesheet content
• edifix-data.output_format (string) - Output format ("JATS", "APA")

Success Response (201 Created):

Error Response (500 Internal Server Error):

GET /api/v1/jobs/:jobId Auth Required

Description: Retrieve job status and details

Path Parameters:

• jobId (integer) - The job ID

Query Parameters:

• edifix_view (string, optional) - Results view type
• Valid values: "refs" (default), "refs_links", "refs_links_delta"
• Example: ?edifix_view=refs_links

Response (200 OK):

Response Fields:

• job_id (integer) - The job ID
• status (string) - Job status: "QUEUED", "SENT", "COMPLETE", or "FAILED"
• job_results (string|null) - Formatted reference results (only present when status is "COMPLETE")