Skip to main content
Cradl AI logo
  • Category: documents & ocr
  • Auth: S2S_OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 11
  • Triggers: 0
  • Slug: CRADL_AI
  • Version: 20261101_00

Tools

Slug: CRADL_AI_DOWNLOAD_FILEDownload document, OCR, annotation, prediction, or run-variable content from an exact Cradl AI file-service URL with a cradl:file ID.

Input Parameters

string
required
Exact https://files.api.cradl.ai URL returned by a Cradl AI resource.
string
Optional filename for the downloaded file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CRADL_AI_GET_AGENT_RUNGet the current state and outputs of one Cradl AI agent run. Poll this read-only tool until the run reaches a terminal status; it does not itself consume page quota.

Input Parameters

string
required
Bare run identifier returned by Start Agent Run or List Agent Runs, such as cradl:run:… .
string
required
Agent identifier that owns the run.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CRADL_AI_GET_DOCUMENTGet metadata, processing links, and annotations for one Cradl AI document by ID. This read does not consume page quota.

Input Parameters

string
required
Document identifier returned by List Documents or document creation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CRADL_AI_GET_PREDICTIONGet one extracted prediction, including its status, fields, errors, and downloadable output references. This read does not consume page quota.

Input Parameters

string
required
Prediction identifier returned by List Predictions or a run output.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CRADL_AI_LIST_AGENT_RUNSList processing runs for an agent, optionally filtered by status or creation/update time. Use this to discover recent extraction jobs and their run IDs.

Input Parameters

string ("archived" | "exported" | "pending-export" | "pending-predictions" | "ready-for-review" | "review-completed" | "succeeded-predictions" | "error" | "running" | "completed" | "review-in-progress")
Return only runs in the selected provider-defined status.
string
required
Agent identifier whose runs should be listed.
integer
Maximum runs to return in this page; Cradl does not document an upper bound.
string
Opaque continuation token returned by a previous call. Omit for the first page and pass it back without modification.
string
Return only runs with updatedTime after this ISO 8601 timestamp.
string
Return only runs with createdTime before this ISO 8601 timestamp.
string
Return only runs with updatedTime before this ISO 8601 timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CRADL_AI_LIST_AGENTSList document-processing agents available to the connected Cradl AI workspace. Use an agent ID from this result to start an extraction run.

Input Parameters

integer
Maximum agents to return in this page; Cradl does not document an upper bound.
string
Opaque continuation token returned by a previous call. Pass it back unchanged, or omit it for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CRADL_AI_LIST_DOCUMENTSList documents in the connected Cradl AI workspace and discover document IDs and content/output file URLs.

Input Parameters

string ("ascending" | "descending")
Sort documents in ascending or descending order.
string
Sort documents by their creation timestamp.
Optional consent-ID filter.
string
Optional dataset-ID filter.
string
Optional exact document-ID filter.
integer
Maximum documents to return in this page; Cradl does not document an upper bound.
string
Opaque continuation token returned by a previous call. Pass it back unchanged, or omit it for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CRADL_AI_LIST_PREDICTIONSList extracted predictions, optionally filtered by model, and discover prediction IDs and output file URLs.

Input Parameters

string ("ascending" | "descending")
Sort predictions in ascending or descending order.
string
Sort predictions by their creation timestamp.
string
Optional model identifier to filter predictions.
integer
Maximum predictions to return in this page; Cradl does not document an upper bound.
string
Opaque continuation token returned by a previous call. Omit it for the first page and pass it back unchanged to continue.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CRADL_AI_PROCESS_DOCUMENTCreate a Cradl agent run and document, then upload one document for asynchronous extraction, consuming processed-page quota. The tool returns after upload without polling; poll the run using the original agent ID and returned bare run ID, and use the composite agent run ID for document attachment. On certain failures it attempts to delete the created document and run; do not automatically retry an ambiguous upload outcome.

Input Parameters

object
required
One PDF, image, or email file to process.
string
Optional persistent document name.
string
required
Exact Cradl agent ID that should process the document.
object
Optional caller metadata to persist on the document.
object
Optional variables made available to the new agent run.
string
Optional persistent document description.
string ("application/pdf" | "image/jpeg" | "image/png" | "image/tiff" | "image/webp" | "message/rfc822")
required
MIME type to record for the uploaded document.
integer
Optional document retention period from 1 through 1825 days.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CRADL_AI_START_AGENT_RUNCreate a processing run for an existing Cradl AI agent. This creates persistent run state; attaching and processing document content against the run consumes the workspace’s monthly processed-page quota.

Input Parameters

string
required
Agent identifier from List Agents.
object
Optional variables made available to the agent run.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CRADL_AI_UPLOAD_DOCUMENT_TO_RUNCreate a document attached to a Cradl AI agent run and upload its PDF, image, or email content for asynchronous processing, consuming processed-page quota. On certain failures, the tool attempts to delete the created document.

Input Parameters

object
required
PDF, image, or email file to upload.
string
Optional human-readable document name.
object
Optional caller metadata to store on the document.
string
Optional document description.
string
required
Composite agent run ID from Start Agent Run’s id field, containing the agent and run IDs and optionally an organization prefix.
string ("application/pdf" | "image/jpeg" | "image/png" | "image/tiff" | "image/webp" | "message/rfc822")
required
MIME type of the document file.
integer
Optional retention period in days, from 1 through 1825.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not