The XCom API from Apache Airflow — 2 operation(s) for xcom.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/apache-airflow-xcom-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Apache Airflow X Com API
x-refined-note:
- x-apisguru-categories differs across the merged source definitions and was not carried
- x-logo differs across the merged source definitions and was not carried
- x-origin differs across the merged source definitions and was not carried
- x-providerName differs across the merged source definitions and was not carried
- x-serviceName differs across the merged source definitions and was not carried
version: '1.0'
description: 'Operations tagged XCom across 2 of this provider''s published API definitions: airflow-xcom-api-openapi.yml, apache-airflow-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- description: Apache Airflow Stable API.
url: /api/v1
- url: https://apache.local
tags:
- name: XCom
paths:
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries/{xcom_key}:
get:
tags:
- XCom
summary: Airflow Get Xcom Entry
description: Get an XCom entry.
operationId: get_xcom_entry
security:
- OAuth2PasswordBearer: []
- HTTPBearer: []
parameters:
- name: dag_id
in: path
required: true
schema:
type: string
title: Dag Id
- name: task_id
in: path
required: true
schema:
type: string
title: Task Id
- name: dag_run_id
in: path
required: true
schema:
type: string
title: Dag Run Id
- name: xcom_key
in: path
required: true
schema:
type: string
title: Xcom Key
- name: map_index
in: query
required: false
schema:
type: integer
minimum: -1
default: -1
title: Map Index
- name: deserialize
in: query
required: false
schema:
type: boolean
default: false
title: Deserialize
- name: stringify
in: query
required: false
schema:
type: boolean
default: false
title: Stringify
responses:
'200':
description: Successful Response
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/XComResponseNative'
- $ref: '#/components/schemas/XComResponseString'
title: Response Get Xcom Entry
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Forbidden
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Bad Request
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Not Found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
patch:
tags:
- XCom
summary: Airflow Update Xcom Entry
description: Update an existing XCom entry.
operationId: update_xcom_entry
security:
- OAuth2PasswordBearer: []
- HTTPBearer: []
parameters:
- name: dag_id
in: path
required: true
schema:
type: string
title: Dag Id
- name: task_id
in: path
required: true
schema:
type: string
title: Task Id
- name: dag_run_id
in: path
required: true
schema:
type: string
title: Dag Run Id
- name: xcom_key
in: path
required: true
schema:
type: string
title: Xcom Key
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/XComUpdateBody'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/XComResponseNative'
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Forbidden
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Bad Request
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Not Found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
tags:
- XCom
summary: Airflow Delete Xcom Entry
description: Delete an XCom entry.
operationId: delete_xcom_entry
security:
- OAuth2PasswordBearer: []
- HTTPBearer: []
parameters:
- name: dag_id
in: path
required: true
schema:
type: string
title: Dag Id
- name: task_id
in: path
required: true
schema:
type: string
title: Task Id
- name: dag_run_id
in: path
required: true
schema:
type: string
title: Dag Run Id
- name: xcom_key
in: path
required: true
schema:
type: string
title: Xcom Key
- name: map_index
in: query
required: false
schema:
type: integer
minimum: -1
default: -1
title: Map Index
responses:
'204':
description: Successful Response
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Forbidden
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Bad Request
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Not Found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries:
get:
tags:
- XCom
summary: Airflow Get Xcom Entries
description: 'Get all XCom entries.
This endpoint allows specifying `~` as the dag_id, dag_run_id, task_id to retrieve XCom entries for all DAGs.'
operationId: get_xcom_entries
security:
- OAuth2PasswordBearer: []
- HTTPBearer: []
parameters:
- name: dag_id
in: path
required: true
schema:
type: string
title: Dag Id
- name: dag_run_id
in: path
required: true
schema:
type: string
title: Dag Run Id
- name: task_id
in: path
required: true
schema:
type: string
title: Task Id
- name: xcom_key
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Xcom Key
- name: map_index
in: query
required: false
schema:
anyOf:
- type: integer
minimum: -1
- type: 'null'
title: Map Index
- name: limit
in: query
required: false
schema:
type: integer
minimum: 0
default: 50
title: Limit
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
default: 0
title: Offset
- name: xcom_key_pattern
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported.
title: Xcom Key Pattern
description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported.
- name: dag_display_name_pattern
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported.
title: Dag Display Name Pattern
description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported.
- name: run_id_pattern
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported.
title: Run Id Pattern
description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported.
- name: task_id_pattern
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported.
title: Task Id Pattern
description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported.
- name: map_index_filter
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
title: Map Index Filter
- name: logical_date_gte
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Logical Date Gte
- name: logical_date_gt
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Logical Date Gt
- name: logical_date_lte
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Logical Date Lte
- name: logical_date_lt
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Logical Date Lt
- name: run_after_gte
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Run After Gte
- name: run_after_gt
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Run After Gt
- name: run_after_lte
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Run After Lte
- name: run_after_lt
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Run After Lt
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/XComCollectionResponse'
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Forbidden
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Bad Request
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Not Found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
tags:
- XCom
summary: Airflow Create Xcom Entry
description: Create an XCom entry.
operationId: create_xcom_entry
security:
- OAuth2PasswordBearer: []
- HTTPBearer: []
parameters:
- name: dag_id
in: path
required: true
schema:
type: string
title: Dag Id
- name: task_id
in: path
required: true
schema:
type: string
title: Task Id
- name: dag_run_id
in: path
required: true
schema:
type: string
title: Dag Run Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/XComCreateBody'
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/XComResponseNative'
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Forbidden
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Bad Request
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Not Found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries:
parameters:
- $ref: '#/components/parameters/DAGID'
- $ref: '#/components/parameters/DAGRunID'
- $ref: '#/components/parameters/TaskID'
get:
description: This endpoint allows specifying `~` as the dag_id, dag_run_id, task_id to retrieve XCOM entries for for all DAGs, DAG runs and task instances. XCom values won't be returned as they can be large. Use this endpoint to get a list of XCom entries and then fetch individual entry to get value.
operationId: getDagsByDagIdDagRunsByDagRunIdTaskInstancesByTaskIdXcomEntries
parameters:
- $ref: '#/components/parameters/PageLimit'
- $ref: '#/components/parameters/PageOffset'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/XComCollection'
description: Success.
'401':
$ref: '#/components/responses/Unauthenticated'
'403':
$ref: '#/components/responses/PermissionDenied'
summary: Apache Airflow List XCom Entries
tags:
- XCom
x-openapi-router-controller: airflow.api_connexion.endpoints.xcom_endpoint
x-operation-id-source: normalized
x-operation-id-original: get_xcom_entries
servers:
- description: Apache Airflow Stable API.
url: /api/v1
- url: https://apache.local
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries/{xcom_key}:
parameters:
- $ref: '#/components/parameters/DAGID'
- $ref: '#/components/parameters/DAGRunID'
- $ref: '#/components/parameters/TaskID'
- $ref: '#/components/parameters/XComKey'
get:
operationId: getDagsByDagIdDagRunsByDagRunIdTaskInstancesByTaskIdXcomEntriesByXcomKey
parameters:
- description: 'Whether to deserialize an XCom value when using a custom XCom backend.
The XCom API endpoint calls `orm_deserialize_value` by default since an XCom may contain value
that is potentially expensive to deserialize in the web server. Setting this to true overrides
the consideration, and calls `deserialize_value` instead.
This parameter is not meaningful when using the default XCom backend.
*New in version 2.4.0*
'
in: query
name: deserialize
required: false
schema:
default: false
type: boolean
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/XCom'
description: Success.
'401':
$ref: '#/components/responses/Unauthenticated'
'403':
$ref: '#/components/responses/PermissionDenied'
'404':
$ref: '#/components/responses/NotFound'
summary: Apache Airflow Get an XCom Entry
tags:
- XCom
x-openapi-router-controller: airflow.api_connexion.endpoints.xcom_endpoint
x-operation-id-source: normalized
x-operation-id-original: get_xcom_entry
servers:
- description: Apache Airflow Stable API.
url: /api/v1
- url: https://apache.local
components:
schemas:
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
XComCollectionResponse:
properties:
xcom_entries:
items:
$ref: '#/components/schemas/XComResponse'
type: array
title: Xcom Entries
total_entries:
type: integer
title: Total Entries
type: object
required:
- xcom_entries
- total_entries
title: XComCollectionResponse
description: XCom Collection serializer for responses.
XComCreateBody:
properties:
key:
type: string
title: Key
value:
title: Value
map_index:
type: integer
title: Map Index
default: -1
additionalProperties: false
type: object
required:
- key
- value
title: XComCreateBody
description: Payload serializer for creating an XCom entry.
XComResponseString:
properties:
key:
type: string
title: Key
timestamp:
type: string
format: date-time
title: Timestamp
logical_date:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Logical Date
map_index:
type: integer
title: Map Index
task_id:
type: string
title: Task Id
dag_id:
type: string
title: Dag Id
run_id:
type: string
title: Run Id
dag_display_name:
type: string
title: Dag Display Name
task_display_name:
type: string
title: Task Display Name
run_after:
type: string
format: date-time
title: Run After
value:
anyOf:
- type: string
- type: 'null'
title: Value
type: object
required:
- key
- timestamp
- logical_date
- map_index
- task_id
- dag_id
- run_id
- dag_display_name
- task_display_name
- run_after
- value
title: XComResponseString
description: XCom response serializer with string return type.
XComResponse:
properties:
key:
type: string
title: Key
timestamp:
type: string
format: date-time
title: Timestamp
logical_date:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Logical Date
map_index:
type: integer
title: Map Index
task_id:
type: string
title: Task Id
dag_id:
type: string
title: Dag Id
run_id:
type: string
title: Run Id
dag_display_name:
type: string
title: Dag Display Name
task_display_name:
type: string
title: Task Display Name
run_after:
type: string
format: date-time
title: Run After
type: object
required:
- key
- timestamp
- logical_date
- map_index
- task_id
- dag_id
- run_id
- dag_display_name
- task_display_name
- run_after
title: XComResponse
description: Serializer for a xcom item.
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
XComResponseNative:
properties:
key:
type: string
title: Key
timestamp:
type: string
format: date-time
title: Timestamp
logical_date:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Logical Date
map_index:
type: integer
title: Map Index
task_id:
type: string
title: Task Id
dag_id:
type: string
title: Dag Id
run_id:
type: string
title: Run Id
dag_display_name:
type: string
title: Dag Display Name
task_display_name:
type: string
title: Task Display Name
run_after:
type: string
format: date-time
title: Run After
value:
title: Value
type: object
required:
- key
- timestamp
- logical_date
- map_index
- task_id
- dag_id
- run_id
- dag_display_name
- task_display_name
- run_after
- value
title: XComResponseNative
description: XCom response serializer with native return type.
HTTPExceptionResponse:
properties:
detail:
anyOf:
- type: string
- additionalProperties: true
type: object
title: Detail
type: object
required:
- detail
title: HTTPExceptionResponse
description: HTTPException Model used for error response.
XComUpdateBody:
properties:
value:
title: Value
map_index:
type: integer
title: Map Index
default: -1
additionalProperties: false
type: object
required:
- value
title: XComUpdateBody
description: Payload serializer for updating an XCom entry.
Error:
description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.
'
properties:
detail:
description: A human-readable explanation specific to this occurrence of the problem.
type: string
instance:
description: 'A URI reference that identifies the specific occurrence of the problem. It may or may
not yield further information if dereferenced.
'
type: string
status:
description: The HTTP status code generated by the API server for this occurrence of the problem.
type: number
title:
description: A short, human-readable summary of the problem type.
type: string
type:
description: 'A URI reference [RFC3986] that identifies the problem type. This specification
encourages that, when dereferenced, it provide human-readable documentation for
the problem type.
'
type: string
required:
- type
- title
- status
type: object
XComCollectionItem:
description: 'XCom entry collection item.
The value field is only available when reading a single object due to the size of the value.
'
properties:
dag_id:
type: string
execution_date:
format: datetime
type: string
key:
type: string
task_id:
type: string
timestamp:
format: datetime
type: string
type: object
XCom:
allOf:
- $ref: '#/components/schemas/XComCollectionItem'
- properties:
value:
description: The value
type: string
type: object
description: Full representations of XCom entry.
XComCollection:
allOf:
- properties:
xcom_entries:
items:
$ref: '#/components/schemas/XComCollectionItem'
type: array
type: object
- $ref: '#/components/schemas/CollectionInfo'
description: 'Collection of XCom entries.
*Changed in version 2.1.0*: ''total_entries'' field is added.
'
type: object
CollectionInfo:
description: Metadata about collection.
properties:
total_entries:
description: 'Count of total objects in the current result set before pagination parameters
(limit, offset) are applied.
'
type: integer
type: object
parameters:
XComKey:
description: The XCom key.
in: path
name: xcom_key
required: true
schema:
type: string
DAGRunID:
description: The DAG run ID.
in: path
name: dag_run_id
required: true
schema:
type: string
DAGID:
description: The DAG ID.
in: path
name: dag_id
required: true
schema:
type: string
PageOffset:
description: The number of items to skip before starting to collect the result set.
in: query
name: offset
required: false
schema:
minimum: 0
type: integer
PageLimit:
description: The numbers of items to return.
in: query
name: limit
required: false
schema:
default: 100
type: integer
TaskID:
description: The task ID.
in: path
name: task_id
required: true
schema:
type: string
responses:
Unauthenticated:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Request not authenticated due to missing, invalid, authentication info.
NotFound:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: A specified resource is not found.
PermissionDenied:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Client does not have sufficient permission.
securitySchemes:
OAuth2PasswordBearer:
type: oauth2
description: To authenticate Airflow API requests, clients must include a JWT (JSON Web Token) in the Authorization header of each request. This token is used to verify the identity of the client and ensure that they have the appropriate permissions to access the requested resources. You can use the endpoint ``POST /auth/token`` in order to generate a JWT token. Upon successful authentication, the server will issue a JWT token that contains the necessary information (such as user identity and scope) to authenticate subsequent requests. To learn more about Airflow public API authentication, please read https://airflow.apache.org/docs/apache-airflow/stable/security/api.html.
flows:
password:
scopes: {}
tokenUrl: /auth/token
HTTPBearer:
type: http
scheme: bearer
Basic:
scheme: basic
type: http
GoogleOpenId:
openIdConnectUrl: https://accounts.google.com/.well-known/openid-configuration
type: openIdConnect
Kerberos:
scheme: negotiate
type: http
externalDocs:
url: https://airflow.apache.org/docs/apache-airflow/stable/
x-refined-from:
- airflow-xcom-api-openapi.yml
- apache-airflow-openapi.yaml