curl --request POST \
--url https://api.example.com/api/artifacts/latest/filter \
--header 'Content-Type: application/json' \
--data '
{
"sort": "ID_DESC",
"offset": 0,
"artifacts": {
"operator": "and_",
"latest_id": {
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"key": {
"any_": [
"<string>"
],
"like_": "my-artifact-%",
"exists_": true
},
"flow_run_id": {
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"task_run_id": {
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"type": {
"any_": [
"<string>"
],
"not_any_": [
"<string>"
]
}
},
"flow_runs": {
"operator": "and_",
"id": {
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"not_any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"name": {
"any_": [
"my-flow-run-1",
"my-flow-run-2"
],
"like_": "marvin"
},
"tags": {
"operator": "and_",
"all_": [
"tag-1",
"tag-2"
],
"any_": [
"tag-1",
"tag-2"
],
"is_null_": true
},
"deployment_id": {
"operator": "and_",
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"is_null_": true
},
"work_queue_name": {
"operator": "and_",
"any_": [
"work_queue_1",
"work_queue_2"
],
"is_null_": true
},
"state": {
"operator": "and_",
"type": {
"any_": [
"SCHEDULED"
],
"not_any_": [
"SCHEDULED"
]
},
"name": {
"any_": [
"<string>"
],
"not_any_": [
"<string>"
]
}
},
"flow_version": {
"any_": [
"<string>"
]
},
"start_time": {
"before_": "2023-11-07T05:31:56Z",
"after_": "2023-11-07T05:31:56Z",
"is_null_": true
},
"end_time": {
"before_": "2023-11-07T05:31:56Z",
"after_": "2023-11-07T05:31:56Z",
"is_null_": true
},
"expected_start_time": {
"before_": "2023-11-07T05:31:56Z",
"after_": "2023-11-07T05:31:56Z"
},
"next_scheduled_start_time": {
"before_": "2023-11-07T05:31:56Z",
"after_": "2023-11-07T05:31:56Z"
},
"parent_flow_run_id": {
"operator": "and_",
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"parent_task_run_id": {
"operator": "and_",
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"is_null_": true
},
"idempotency_key": {
"any_": [
"<string>"
],
"not_any_": [
"<string>"
]
}
},
"task_runs": {
"operator": "and_",
"id": {
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"name": {
"any_": [
"my-task-run-1",
"my-task-run-2"
],
"like_": "marvin"
},
"tags": {
"operator": "and_",
"all_": [
"tag-1",
"tag-2"
],
"is_null_": true
},
"state": {
"operator": "and_",
"type": {
"any_": [
"SCHEDULED"
]
},
"name": {
"any_": [
"<string>"
]
}
},
"start_time": {
"before_": "2023-11-07T05:31:56Z",
"after_": "2023-11-07T05:31:56Z",
"is_null_": true
},
"expected_start_time": {
"before_": "2023-11-07T05:31:56Z",
"after_": "2023-11-07T05:31:56Z"
},
"subflow_runs": {
"exists_": true
},
"flow_run_id": {
"operator": "and_",
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"is_null_": false
}
},
"flows": {
"operator": "and_",
"id": {
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"deployment": {
"operator": "and_",
"is_null_": true
},
"name": {
"any_": [
"my-flow-1",
"my-flow-2"
],
"like_": "marvin"
},
"tags": {
"operator": "and_",
"all_": [
"tag-1",
"tag-2"
],
"is_null_": true
}
},
"deployments": {
"operator": "and_",
"id": {
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"not_any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"name": {
"any_": [
"my-deployment-1",
"my-deployment-2"
],
"like_": "marvin"
},
"flow_or_deployment_name": {
"like_": "<string>"
},
"paused": {
"eq_": true
},
"tags": {
"operator": "and_",
"all_": [
"tag-1",
"tag-2"
],
"any_": [
"tag-1",
"tag-2"
],
"is_null_": true
},
"work_queue_name": {
"any_": [
"work_queue_1",
"work_queue_2"
]
},
"concurrency_limit": {
"ge_": 123,
"le_": 123,
"is_null_": true
}
},
"limit": 123
}
'[
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"key": "<string>",
"latest_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"description": "<string>",
"data": {},
"metadata_": {},
"flow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"task_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]Read Latest Artifacts
Retrieve artifacts from the database.
curl --request POST \
--url https://api.example.com/api/artifacts/latest/filter \
--header 'Content-Type: application/json' \
--data '
{
"sort": "ID_DESC",
"offset": 0,
"artifacts": {
"operator": "and_",
"latest_id": {
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"key": {
"any_": [
"<string>"
],
"like_": "my-artifact-%",
"exists_": true
},
"flow_run_id": {
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"task_run_id": {
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"type": {
"any_": [
"<string>"
],
"not_any_": [
"<string>"
]
}
},
"flow_runs": {
"operator": "and_",
"id": {
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"not_any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"name": {
"any_": [
"my-flow-run-1",
"my-flow-run-2"
],
"like_": "marvin"
},
"tags": {
"operator": "and_",
"all_": [
"tag-1",
"tag-2"
],
"any_": [
"tag-1",
"tag-2"
],
"is_null_": true
},
"deployment_id": {
"operator": "and_",
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"is_null_": true
},
"work_queue_name": {
"operator": "and_",
"any_": [
"work_queue_1",
"work_queue_2"
],
"is_null_": true
},
"state": {
"operator": "and_",
"type": {
"any_": [
"SCHEDULED"
],
"not_any_": [
"SCHEDULED"
]
},
"name": {
"any_": [
"<string>"
],
"not_any_": [
"<string>"
]
}
},
"flow_version": {
"any_": [
"<string>"
]
},
"start_time": {
"before_": "2023-11-07T05:31:56Z",
"after_": "2023-11-07T05:31:56Z",
"is_null_": true
},
"end_time": {
"before_": "2023-11-07T05:31:56Z",
"after_": "2023-11-07T05:31:56Z",
"is_null_": true
},
"expected_start_time": {
"before_": "2023-11-07T05:31:56Z",
"after_": "2023-11-07T05:31:56Z"
},
"next_scheduled_start_time": {
"before_": "2023-11-07T05:31:56Z",
"after_": "2023-11-07T05:31:56Z"
},
"parent_flow_run_id": {
"operator": "and_",
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"parent_task_run_id": {
"operator": "and_",
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"is_null_": true
},
"idempotency_key": {
"any_": [
"<string>"
],
"not_any_": [
"<string>"
]
}
},
"task_runs": {
"operator": "and_",
"id": {
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"name": {
"any_": [
"my-task-run-1",
"my-task-run-2"
],
"like_": "marvin"
},
"tags": {
"operator": "and_",
"all_": [
"tag-1",
"tag-2"
],
"is_null_": true
},
"state": {
"operator": "and_",
"type": {
"any_": [
"SCHEDULED"
]
},
"name": {
"any_": [
"<string>"
]
}
},
"start_time": {
"before_": "2023-11-07T05:31:56Z",
"after_": "2023-11-07T05:31:56Z",
"is_null_": true
},
"expected_start_time": {
"before_": "2023-11-07T05:31:56Z",
"after_": "2023-11-07T05:31:56Z"
},
"subflow_runs": {
"exists_": true
},
"flow_run_id": {
"operator": "and_",
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"is_null_": false
}
},
"flows": {
"operator": "and_",
"id": {
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"deployment": {
"operator": "and_",
"is_null_": true
},
"name": {
"any_": [
"my-flow-1",
"my-flow-2"
],
"like_": "marvin"
},
"tags": {
"operator": "and_",
"all_": [
"tag-1",
"tag-2"
],
"is_null_": true
}
},
"deployments": {
"operator": "and_",
"id": {
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"not_any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"name": {
"any_": [
"my-deployment-1",
"my-deployment-2"
],
"like_": "marvin"
},
"flow_or_deployment_name": {
"like_": "<string>"
},
"paused": {
"eq_": true
},
"tags": {
"operator": "and_",
"all_": [
"tag-1",
"tag-2"
],
"any_": [
"tag-1",
"tag-2"
],
"is_null_": true
},
"work_queue_name": {
"any_": [
"work_queue_1",
"work_queue_2"
]
},
"concurrency_limit": {
"ge_": 123,
"le_": 123,
"is_null_": true
}
},
"limit": 123
}
'[
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"key": "<string>",
"latest_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"description": "<string>",
"data": {},
"metadata_": {},
"flow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"task_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]Headers
Body
Defines artifact collection sorting options.
CREATED_DESC, UPDATED_DESC, ID_DESC, KEY_DESC, KEY_ASC x >= 0Filter artifact collections. Only artifact collections matching all criteria will be returned
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ Filter criteria for Artifact.key
Show child attributes
Show child attributes
A list of artifact keys to include
A string to match artifact keys against. This can include SQL wildcard characters like % and _.
"my-artifact-%"
If true, only include artifacts with a non-null key. If false, only include artifacts with a null key. Should return all rows in the ArtifactCollection table if specified.
Filter flow runs. Only flow runs matching all criteria will be returned
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ Filter criteria for FlowRun.name
Show child attributes
Show child attributes
Filter criteria for FlowRun.tags
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ A list of tags. Flow runs will be returned only if their tags are a superset of the list
["tag-1", "tag-2"]A list of tags to include
["tag-1", "tag-2"]If true, only include flow runs without tags
Filter criteria for FlowRun.deployment_id
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ A list of flow run deployment ids to include
If true, only include flow runs without deployment ids
Filter criteria for `FlowRun.work_queue_name
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ A list of work queue names to include
["work_queue_1", "work_queue_2"]If true, only include flow runs without work queue names
Filter criteria for FlowRun.state
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ Filter criteria for FlowRun.state_type
Show child attributes
Show child attributes
A list of flow run state types to include
Enumeration of state types.
SCHEDULED, PENDING, RUNNING, COMPLETED, FAILED, CANCELLED, CRASHED, PAUSED, CANCELLING A list of flow run state types to exclude
Enumeration of state types.
SCHEDULED, PENDING, RUNNING, COMPLETED, FAILED, CANCELLED, CRASHED, PAUSED, CANCELLING Filter criteria for FlowRun.start_time
Show child attributes
Show child attributes
Only include flow runs starting at or before this time
Only include flow runs starting at or after this time
If true, only return flow runs without a start time
Filter criteria for FlowRun.end_time
Show child attributes
Show child attributes
Filter criteria for FlowRun.expected_start_time
Filter criteria for FlowRun.next_scheduled_start_time
Show child attributes
Show child attributes
Filter criteria for subflows of the given flow runs
Filter criteria for FlowRun.parent_task_run_id
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ A list of flow run parent_task_run_ids to include
If true, only include flow runs without parent_task_run_id
Filter task runs. Only task runs matching all criteria will be returned
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ Filter criteria for TaskRun.name
Show child attributes
Show child attributes
Filter criteria for TaskRun.tags
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ A list of tags. Task runs will be returned only if their tags are a superset of the list
["tag-1", "tag-2"]If true, only include task runs without tags
Filter criteria for TaskRun.state
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ Filter criteria for TaskRun.state_type
Show child attributes
Show child attributes
A list of task run state types to include
Enumeration of state types.
SCHEDULED, PENDING, RUNNING, COMPLETED, FAILED, CANCELLED, CRASHED, PAUSED, CANCELLING Filter criteria for TaskRun.start_time
Show child attributes
Show child attributes
Only include task runs starting at or before this time
Only include task runs starting at or after this time
If true, only return task runs without a start time
Filter criteria for TaskRun.expected_start_time
Filter criteria for TaskRun.flow_run_id
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ A list of task run flow run ids to include
Filter for task runs with None as their flow run id
Filter for flows. Only flows matching all criteria will be returned.
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ Filter criteria for Flow.name
Filter criteria for Flow.tags
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ A list of tags. Flows will be returned only if their tags are a superset of the list
["tag-1", "tag-2"]If true, only include flows without tags
Filter for deployments. Only deployments matching all criteria will be returned.
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ Filter criteria for Deployment.name
Show child attributes
Show child attributes
Filter criteria for Deployment.name or Flow.name
Show child attributes
Show child attributes
A case-insensitive partial match on deployment or flow names. For example, passing 'example' might match deployments or flows with 'example' in their names.
Filter criteria for Deployment.tags
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ A list of tags. Deployments will be returned only if their tags are a superset of the list
["tag-1", "tag-2"]A list of tags to include
["tag-1", "tag-2"]If true, only include deployments without tags
DEPRECATED: Prefer Deployment.concurrency_limit_id over Deployment.concurrency_limit. If provided, will be ignored for backwards-compatibility. Will be removed after December 2024.
Show child attributes
Show child attributes
Only include deployments with a concurrency limit greater than or equal to this value
Only include deployments with a concurrency limit less than or equal to this value
If true, only include deployments without a concurrency limit
Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.
Response
Successful Response
An optional unique reference key for this artifact.
The latest artifact ID associated with the key.
An identifier that describes the shape of the data field. e.g. 'result', 'table', 'markdown'
A markdown-enabled description of the artifact.
Data associated with the artifact, e.g. a result.; structure depends on the artifact type.
The flow run associated with the artifact.
The task run associated with the artifact.
Was this page helpful?