The PhariaData API provides a comprehensive suite of endpoints to manage data workflows within the Pharia Data Platform — repositories, datasets, datapoints, stages, files, downloads, connectors, transformations and transformation runs, plus search stores and document management.
{
"openapi": "3.0.1",
"info": {
"title": "PhariaData API",
"description": "The PhariaData API provides a comprehensive suite of endpoints to manage data workflows within the Pharia Data Platform. This API enables users to organize, store, retrieve, and manipulate datasets across repositories with efficiency and control. Key functionalities include the creation and management of datasets, stages, and repositories, as well as streamlined access to data through downloads and real-time data streaming.",
"contact": {
"name": "PhariaData API Support",
"url": "https://aleph-alpha.atlassian.net/servicedesk/customer/portals",
"email": "pharia-data@aleph-alpha.com"
},
"license": {
"name": "Open Aleph License"
},
"version": "1.0.0"
},
"tags": [
{
"name": "Repositories",
"description": "A collection of data organized by a common type, modality, and schema, stored within datasets (lists of data points) in the repositories. To share datasets externally, they must first be exported as files, which will then be stored in the internal storage of the data platform."
},
{
"name": "Datasets",
"description": "Represents the primary data abstraction within the data platform, serving as a structured collection of data points. Datasets can be either manually uploaded or generated through data transformations, providing a versatile means for organizing, storing, and retrieving data across various use cases."
},
{
"name": "Stages",
"description": "Stages serve as the data platform's entry point for data collection, where source files are securely stored, enabling subsequent transformations and dataset generation. Files can be uploaded directly into stages via the HTTP API or through connectors, which support automated and continuous synchronization with your source systems. Stages provide secure, persistent storage and act as an interface for importing and exporting data files within the platform. To improve data discoverability, comprehension, and quality for end users, the data platform offers datasets as the recommended abstraction for organizing and sharing data."
},
{
"name": "Downloads",
"description": "Endpoints for managing and tracking dataset download requests within the data platform. These endpoints allow users to initiate new downloads, retrieve details of specific download requests, and list download activity for datasets, with optional filters by date and repository. Download management helps streamline access to dataset files and provides caching capabilities."
},
{
"name": "Transformations",
"description": "Available transformations can be applied to an input data object of type A to produce an output data object of type B. The output data object will consist of a sequence of items, each of which will conform to an Avro schema specified in the transformation as OutputSchema. Currently, the input data object can be a File located in a Stage within the Data Platform. Future versions will support receiving Datasets from Repositories in the Data Platform as input data objects. The output data object can be loaded into various types of data storage within the Data Platform, with Repositories being the first supported storage type. When triggering a transformation, this has to be specified as destination. After loading the output into the destination, it can also be sent to an external service through available connectors in the Data Platform. The first available connector will be the Document Index Collection Connector."
},
{
"name": "Connectors",
"description": "Available connectors for the Data Platform to ingest data from external sources."
},
{
"name": "Search Store",
"description": "A Search Store is a structured data repository optimized for indexing and retrieving searchable entities. It supports full-text search, metadata-based filtering, and relevance ranking. Each Search Store can manage multiple indexed documents, making it ideal for fast, scalable information retrieval across different modalities."
},
{
"name": "Document",
"description": "A Document represents an individual item stored within a Search Store. Documents can contain content from various modalities, such as text, images, or pre-chunked data."
}
],
"security": [
{
"Bearer": []
}
],
"paths": {
"/transformations": {
"get": {
"tags": [
"Transformations"
],
"summary": "Retrieve a list of available transformations",
"description": "Fetches a paginated list of all available transformations in the Data Platform.",
"parameters": [
{
"name": "page",
"in": "query",
"description": "The page number to retrieve, used for paginated responses.",
"schema": {
"type": "integer",
"example": 0
}
},
{
"name": "size",
"in": "query",
"description": "The number of items to include per page in the response.",
"schema": {
"type": "integer",
"example": 10
}
},
{
"name": "name",
"in": "query",
"description": "Search for transformations by their specific name.",
"schema": {
"type": "string",
"example": "DocumentToText"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransformationListWithPagination"
}
}
}
},
"401": {
"description": "UNAUTHORIZED When access token is invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HandleFailedResponse"
}
}
}
},
"500": {
"description": "INTERNAL SERVER ERROR",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HandleFailedResponse"
}
}
}
},
"400": {
"description": "BAD REQUEST",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HandleFailedResponse"
}
}
}
}
}
}
},
"/transformations/{transformationID}": {
"get": {
"tags": [
"Transformations"
],
"summary": "Retrieve transformation details by ID",
"description": "Retrieves detailed information for a specific transformation identified by its unique ID. Includes properties such as name, input media type, supported destinations, and output schema.",
"parameters": [
{
"name": "transformationID",
"in": "path",
"description": "Unique identifier for the transformation.",
"required": true,
"schema": {
"type": "string",
"example": "cb26237c-3beb-40f3-8e13-77d862f722b5"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Transformation"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HandleFailedResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HandleFailedResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HandleFailedResponse"
}
}
}
},
"500": {
"description": "INTERNAL SERVER ERROR",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HandleFailedResponse"
}
}
}
}
}
}
},
"/transformations/{transformationID}/runs": {
"post": {
"tags": [
"Transformations"
],
"summary": "Trigger a transformation",
"description": "Initiates a transformation process for a specific transformation, identified by its unique ID. The operation applies the transformation to the input data object and stores the result in the specified destination. If connector configurations are provided, the output can also be delivered to external services. Some transformations accept parameters: the list of the allowed parameters for each transformation can be retrieved by the list transformations endpoint. ```Note: If a file is TXT or Markdown format, only files with UTF-8 encoding and LF as line feed character are supported.```\n",
"parameters": [
{
"name": "transformationID",
"in": "path",
"description": "Unique identifier for the transformation.",
"required": true,
"schema": {
"type": "string",
"example": "cb26237c-3beb-40f3-8e13-77d862f722b5"
}
}
],
"requestBody": {
"description": "Transformation parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransformationRunCreate"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransformationRun"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HandleFailedResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HandleFailedResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HandleFailedResponse"
}
}
}
},
"413": {
"description": "Request Entity Too Large",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HandleFailedResponse"
}
}
}
}
}
},
"get": {
"tags": [
"Transformations"
],
"summary": "Retrieve a list of created runs given a transformation ID",
"description": "Fetches a paginated list of all created runs in the Data Platform for a specific transformation.",
"parameters": [
{
"name": "transformationID",
"in": "path",
"description": "Unique identifier for the transformation.",
"required": true,
"schema": {
"type": "string",
"example": "cb26237c-3beb-40f3-8e13-77d862f722b5"
}
},
{
"name": "page",
"in": "query",
"description": "The page number to retrieve, used for paginated responses.",
"schema": {
"type": "integer",
"example": 0
}
},
{
"name": "size",
"in": "query",
"description": "The number of items to include per page in the response.",
"schema": {
"type": "integer",
"example": 10
}
},
{
"name": "file_id",
"in": "query",
"description": "A file ID to filter the list of runs that received this file as input.",
"schema": {
"type": "string",
"example": "cb26237c-3beb-40f3-8e13-77d862f722b5"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunListWithPagination"
}
}
}
},
"400": {
"description": "BAD REQUEST",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HandleFailedResponse"
}
}
}
},
"401": {
"description": "UNAUTHORIZED When access token is invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HandleFailedResponse"
}
}
}
},
"500": {
"description": "INTERNAL SERVER ERROR",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HandleFailedResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HandleFailedResponse"
}
}
}
}
}
}
},
"/transformations/{transformationID}/runs/events": {
"get": {
"tags": [
"Transformations"
],
"summary": "Stream real-time run updates for a transformation",
"description": "Opens a Server-Sent Events (SSE) connection that streams live run updates for a specific transformation.\n\n**SSE Events:**\n- `connected`: Connection established\n- `runs:new`: New runs appeared on the current page\n- `runs:updated`: Existing runs changed status\n- `runs:removed`: Runs fell off the current page window (e.g. pushed out by newer runs)\n- `done`: All currently visible runs reached a terminal state\n- `error`: Stream error occurred\n\nThe stream closes automatically when all runs reach a terminal state or when the client disconnects.",
"parameters": [
{
"name": "transformationID",
"in": "path",
"description": "Unique identifier for the transformation.",
"required": true,
"schema": {
"type": "string",
"example": "cb26237c-3beb-40f3-8e13-77d862f722b5"
}
},
{
"name": "page",
"in": "query",
"description": "The page number to retrieve, used for paginated responses.",
"schema": {
"type": "integer",
"example": 0
}
},
{
"name": "size",
"in": "query",
"description": "The number of items to include per page in the response.",
"schema": {
"type": "integer",
"example": 10
}
},
{
"name": "file_id",
"in": "query",
"description": "A file ID to filter the list of runs that received this file as input.",
"schema": {
"type": "string",
"example": "cb26237c-3beb-40f3-8e13-77d862f722b5"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/event-stream": {
"schema": {
"type": "string",
"description": "Server-Sent Events stream with real-time run updates",
"example": "event: connected\ndata: {\"message\":\"Connected to runs stream\",\"transformationId\":\"...\"}\n\nevent: runs:new\ndata: {\"runs\":[...],\"count\":1,\"total\":5}\n\nevent: runs:updated\ndata: {\"runs\":[...],\"count\":1,\"total\":5}\n\nevent: runs:removed\ndata: {\"runIds\":[\"...\"],\"count\":1,\"total\":4}\n\n: keepalive at 2026-01-01T00:00:00Z\n\nevent: done\ndata: {\"message\":\"All runs have reached a terminal state\"}\n"
}
}
}
},
"400": {
"description": "BAD REQUEST",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HandleFailedResponse"
}
}
}
},
"401": {
"description": "UNAUTHORIZED When access token is invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HandleFailedResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HandleFailedResponse"
}
}
}
},
"500": {
"description": "INTERNAL SERVER ERROR",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HandleFailedResponse"
}
}
}
}
}
}
},
"/transformations/{transformationID}/runs/{runID}": {
"get": {
"tags": [
"Transformations"
],
"summary": "Retrieve transformation run details by ID",
"description": "Fetches detailed information for a specific transformation run identified by its unique ID. Includes properties such as status, start time, end time, and output destination.",
"parameters": [
{
"name": "transformationID",
"in": "path",
"description": "Unique identifier for the transformation.",
"required": true,
"schema": {
"type": "string",
"example": "cb26237c-3beb-40f3-8e13-77d862f722b5"
}
},
{
"name": "runID",
"in": "path",
"description": "Unique identifier for the transformation run.",
"required": true,
"schema": {
"type": "string",
"example": "cb26237c-3beb-40f3-8e13-77d862f722b5"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransformationRun"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HandleFailedResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HandleFailedResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HandleFailedResponse"
}
}
}
},
"500": {
"description": "INTERNAL SERVER ERROR",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HandleFailedResponse"
}
}
}
}
}
}
},
"/transformations/{transformationID}/runs/batch": {
"post": {
"tags": [
"Transformations"
],
"summary": "Trigger multiple transformations in batch",
"description": "Initiates multiple transformation processes for a specific transformation, identified by its unique ID. This endpoint allows you to execute multiple transformation runs simultaneously by providing an array of transformation configurations. Each transformation in the batch applies to its respective input data object and stores the result in the specified destination. If connector configurations are provided, the outputs can also be delivered to external services. Some transformations accept parameters: the list of the allowed parameters for each transformation can be retrieved by the list transformations endpoint. ```Note: If a file is TXT or Markdown format, only files with UTF-8 encoding and LF as line feed character are supported.```\n",
"parameters": [
{
"name": "transformationID",
"in": "path",
"description": "Unique identifier for the transformation.",
"required": true,
"schema": {
"type": "string",
"example": "cb26237c-3beb-40f3-8e13-77d862f722b5"
}
}
],
"requestBody": {
"description": "Array of transformation parameters for batch processing",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TransformationRunCreate"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TransformationRun"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HandleFailedResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HandleFailedResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HandleFailedResponse"
}
}
}
},
"413": {
"description": "Request Entity Too Large",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HandleFailedResponse"
}
}
}
}
},
"security": [
{
"Bearer": []
}
]
}
},
"/repositories": {
"get": {
"tags": [
"Repositories"
],
"summary": "Retrieve a list of repositories",
"description": "Fetches a paginated list of all available repositories with optional filters for med
# --- truncated at 32 KB (298 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aleph-alpha/refs/heads/main/openapi/aleph-alpha-pharia-data-openapi.json
This is an independent, third-party profile of PhariaData API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.