Abairt API Documentation

Access confirmed Mayo Irish transcription data programmatically

Quick Start

1. Get an API Token

Contact an admin to get API access.

2. Authenticate

Include your token in the Authorization header:

Authorization: Bearer YOUR_TOKEN

3. Make Requests

All endpoints return JSON. Rate limit: 100 requests/hour.

Base URL

https://abairt.com/api

OpenAPI Schema

Download JSON Schema

Endpoints

GET /api/transcriptions

Returns a paginated list of confirmed transcriptions with audio URLs.

Query Parameters

Parameter	Type	Default	Description
`page`	integer	1	Page number
`per_page`	integer	50	Items per page (max 100)
`updated_since`	ISO 8601	-	Filter by last update timestamp

Example Request

curl -X GET "https://abairt.com/api/transcriptions?page=1&per_page=10" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

Example Response

{
  "entries": [
    {
      "id": 1234,
      "word_or_phrase": "Dia dhuit",
      "translation": "Hello",
      "region_id": 1,
      "region_start": 0.5,
      "region_end": 1.2,
      "updated_at": "2024-01-15T10:30:00Z",
      "audio_url": "https://...",
      "speaker": {
        "id": 42,
        "name": "Seán Ó Maoilchiaráin",
        "dialect": "erris"
      },
      "voice_recording": {
        "id": 10,
        "title": "Traditional Stories",
        "external_id": "abc123"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 10,
    "total": 5432
  }
}

GET /api/transcriptions/:id

Returns a single transcription by ID.

Path Parameters

Parameter	Type	Description
`id`	integer	The transcription ID

Example Request

curl -X GET "https://abairt.com/api/transcriptions/1234" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

Response Codes

Code	Description
200	Success - Returns requested data
401	Unauthorized - Invalid or missing API token
404	Not Found - Resource doesn't exist
429	Rate Limit Exceeded - 100 requests per hour limit

Data Schema

Transcription

Field	Type	Description
`id`	integer	Unique identifier
`word_or_phrase`	string	The Irish word or phrase
`translation`	string	English translation
`region_id`	integer	Region ID within the voice recording
`region_start`	float	Audio start time in seconds
`region_end`	float	Audio end time in seconds
`updated_at`	datetime	Last update timestamp (ISO 8601)
`audio_url`	string	URL to the audio snippet
`speaker`	object	Speaker information
`voice_recording`	object	Source recording information

Speaker

Field	Type	Description
`id`	integer	Unique identifier
`name`	string	Speaker's name
`dialect`	string	Mayo dialect region (erris, achill, tourmakeady, east_mayo, other)

VoiceRecording

Field	Type	Description
`id`	integer	Unique identifier
`title`	string	Recording title
`external_id`	string	Fotheidil video ID