---
title: "file flight plan"
method: POST
path: "/v1/flight-plans"
tags: ["Platform"]
---

# file flight plan

`POST /v1/flight-plans`

## Request

- Base URL: `https://www.rightshold.com`
- URL: `https://www.rightshold.com/v1/flight-plans`
- Auth: HTTP bearer

## Headers

- `X-Request-Id` string

## Request body

- object
  - `agent` string, required
  - `destination` string, required
  - `purpose` 'read' | 'search_index' | 'crawl' | 'train' | 'transact' | 'post', required
  - `paths` string[]
  - `max_rps` number
  - `minutes` integer
  - `starts_at` string
  - `user_agent` string
  - `note` string

## Response `200`

OK

- object: Inferred from 10 recorded responses; required fields appeared in every one; additional properties may appear.
  - `flight_plan` object, required
    - `id` string, required
    - `agent` string, required
    - `destination` string, required
    - `purpose` string, required
    - `paths` string[], required
    - `max_rps` integer, required
    - `starts_at` string, required
    - `ends_at` string, required
    - `user_agent` string, nullable, required
    - `note` unknown, required
  - `decision` string, required
  - `reasons` string[], required
  - `filed_at` string, required
  - `clearance` object, nullable, required
    - `token` string
    - `expires_at` string
    - `present_as` string
  - `signals` object, required
    - `ai_training` string, required
    - `robots_txt` object, required
      - `found` boolean, required
      - `groups` integer, required
    - `checked_at` string, required
  - `note` string, required
  - `next_action` object, required
    - `action` string, required
    - `label` string, required
    - `why` string, required
    - `needs` string, required
    - `url` string

## Other responses

- `400`: Problem details: a stable error code, type URI, title, status and an explanation
- `401`: Problem details: a stable error code, type URI, title, status and an explanation
- `404`: Problem details: a stable error code, type URI, title, status and an explanation
- `405`: Problem details: a stable error code, type URI, title, status and an explanation
- `422`: Problem details: a stable error code, type URI, title, status and an explanation
- `429`: Request budget exhausted; retry after Retry-After seconds
- `500`: Problem details: a stable error code, type URI, title, status and an explanation
- `4XX`: {error, detail}

---

[API](https://skmtc.dev/rightshold/apis/rightshold-api.md) · [All operations](https://skmtc.dev/rightshold/apis/rightshold-api/llms.txt) · [OpenAPI document](https://skmtc.dev/rightshold/apis/rightshold-api/revisions/cfe84fdde1ca?raw)