---
title: "Run Intake Agent"
method: POST
path: "/intake-agent/run"
tags: ["Agents"]
---

# Run Intake Agent

`POST /intake-agent/run`

## Request

- Base URL: `https://ironcladapp.com/public/api/v1`
- URL: `https://ironcladapp.com/public/api/v1/intake-agent/run`
- Auth: API key in header `Authorization` and OAuth 2
  - Authorization code: `https://ironcladapp.com/oauth/authorize`
  - Client credentials
  - Token URL: `https://ironcladapp.com/oauth/token` scopes: `public.agents.runIntakeAgent`

Run the Intake Agent asynchronously on one or more contract documents to extract form field values for a counterparty paper workflow.

Documents can be provided in two ways:

- **`multipart/form-data`** — Upload one or more files as separate form parts. Each file must have a distinct field name (e.g. `file0`, `file1`). The `template` is sent as a form field.
- **`application/json`** — Provide a `fileUrls` array of publicly accessible URLs. Each URL must return the file bytes directly on `GET` (no authentication). Private documents (e.g. Google Docs without anonymous sharing) are not supported via URL — download them and upload via multipart instead.

Files must have a `.pdf`, `.doc`, or `.docx` extension. Filenames must be unique within a request (extension case is ignored, so `contract.pdf` and `contract.PDF` count as duplicates). Up to 10 files per request on either path. The total size of all files in a request must not exceed 100MB.

The template must accept counterparty paper and have Intake Agent enabled.

**OAuth Scope required:** `public.agents.runIntakeAgent`

## Request body

- object
  - `template` string, required: The identifier of the workflow template
  - `fileUrls` string[], required: Publicly accessible URLs that return file bytes on `GET`. Each URL is fetched server-side.

## Response `200`

The response of the initiated async Intake Agent run.

- object
  - `asyncJobId` string, required
  - `asyncJobStatusUrl` string, required

## Other responses

- `400`: 400
- `401`: 401
- `403`: 403
- `404`: 404
- `415`: 415
- `422`: 422
- `500`: 500

## Changes

- **2026-11-03** `435da5a4396e`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/ironcladapp/apis/ironclad-public-api/changes/intake-agent/run/post.md)

---

[API](https://skmtc.dev/ironcladapp/apis/ironclad-public-api.md) - [All operations](https://skmtc.dev/ironcladapp/apis/ironclad-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ironcladapp/apis/ironclad-public-api/revisions/435da5a4396e?raw)