# Fill in a new campaign from its contract

`POST https://api.tryscouty.com/v1/contract-autofill`

Reads a contract PDF and returns the details of a new campaign it describes (title, description, pay line, deliverables, requirements, countries, targeting and application deadline), as the dashboard's new-campaign form does. Nothing is saved: pass the fields you keep to scouty_create_campaign. Each read is a billed model call, at most 10 per workspace an hour; a retry with the same idempotency key replays the answer rather than reading again. contractBase64 is the PDF as standard base64.

- Scope: `campaigns:write`
- Kind: write
- Safe to retry with the same idempotency key: yes
- MCP tool: `scouty_autofill_campaign_from_contract`

## Authorization

Send `Authorization: Bearer $SCOUTY_TOKEN`. The token needs the `campaigns:write` scope.

## Headers

| Name | Type | Required | Description |
|---|---|---|---|
| `Idempotency-Key` | `string` | Optional | The same key the body's idempotencyKey carries. Send one or the other, or both with the same value. |

## Body parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `idempotencyKey` | `string` | Required | A key you choose for this call, 8 to 128 characters of letters, digits, dot, underscore, colon or hyphen. Sending the same key with the same arguments replays the first answer and changes nothing, so a retry after a timeout is safe. |
| `contractBase64` | `string` | Required | The contract, a PDF, as standard base64 with no data: prefix. |

## Request

### cURL

```bash
printf '{"idempotencyKey":"autofill-acme-1","contractBase64":"%s"}' \
  "$(base64 < contract.pdf | tr -d '\n')" > body.json
curl -s -X POST https://api.tryscouty.com/v1/contract-autofill \
  -H "Authorization: Bearer $SCOUTY_TOKEN" \
  -H "Content-Type: application/json" \
  --data-binary @body.json
```

### JavaScript

```js
import { readFileSync } from "node:fs";

const response = await fetch("https://api.tryscouty.com/v1/contract-autofill", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SCOUTY_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    idempotencyKey: "autofill-acme-1",
    contractBase64: readFileSync("contract.pdf").toString("base64")
  }),
});
console.log(await response.json());
```

### Python

```python
import base64
import os

import requests

token = os.environ["SCOUTY_TOKEN"]
response = requests.post(
    "https://api.tryscouty.com/v1/contract-autofill",
    headers={"Authorization": f"Bearer {token}"},
    json={
        "idempotencyKey": "autofill-acme-1",
        "contractBase64": base64.b64encode(open("contract.pdf", "rb").read()).decode(),
    },
)
print(response.json())
```

## Responses

### 200 OK

```json
{
  "status": "read",
  "fields": {
    "title": "Acme spring launch",
    "overview": "Short videos showing the new Acme bottle in daily use.",
    "payLine": "$150 per video",
    "deliverables": [
      "Two 30 second videos"
    ],
    "requirements": [
      "Based in the United States"
    ],
    "marketCountryCodes": [
      "US"
    ],
    "applicationDeadline": "2026-11-15"
  },
  "researched": false
}
```

### 400 Bad Request

```json
{
  "error": {
    "code": "invalid_request",
    "message": "Those arguments are not the shape this capability takes: idempotencyKey."
  }
}
```

### 401 Unauthorized

```json
{
  "error": {
    "code": "missing_token",
    "message": "This API needs an Authorization header carrying a bearer token."
  }
}
```

### 403 Forbidden

```json
{
  "error": {
    "code": "insufficient_scope",
    "message": "This token does not carry the campaigns:write scope. Ask the team for one that does."
  }
}
```

### 409 Conflict

```json
{
  "error": {
    "code": "idempotency_conflict",
    "message": "That idempotency key was already used for a different request. Use a new key."
  }
}
```

### 429 Too Many Requests

```json
{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please wait for the current minute to end."
  }
}
```

## Errors

| Status | `error.code` | Meaning |
|---|---|---|
| 400 Bad Request | `invalid_request` | The request was not the shape this capability takes, or its body was not JSON. |
| 401 Unauthorized | `missing_token`, `invalid_token`, `token_revoked`, `token_expired`, `token_orphaned` | No token, or one that is not recognized, revoked or expired. |
| 403 Forbidden | `insufficient_scope`, `wrong_principal` | The token does not carry the scope this capability needs. |
| 409 Conflict | `idempotency_conflict` | That idempotency key was already used for a different request. Nothing was changed. |
| 429 Too Many Requests | `rate_limited` | Too many requests this minute. Retry-After says how long is left. |

Full reference: https://docs.tryscouty.com/reference