# API reference

Source: https://joinopenfile.com/docs/api
Index: https://joinopenfile.com/llms.txt

Base URL: `https://api.joinopenfile.com/v1`. The spec is at [/openapi.json](https://joinopenfile.com/openapi.json). Every endpoint is also an [MCP tool](https://joinopenfile.com/docs/mcp.md).

## Plan

| Endpoint | What it does |
| --- | --- |
| [`GET /plan`](https://joinopenfile.com/docs/api/plan-task.md) | Plan a task |

## Pricing

| Endpoint | What it does |
| --- | --- |
| [`GET /pricing`](https://joinopenfile.com/docs/api/get-pricing.md) | Get pricing |
| [`POST /quotes`](https://joinopenfile.com/docs/api/create-quote.md) | Quote an application |

## Classes

| Endpoint | What it does |
| --- | --- |
| [`GET /classes`](https://joinopenfile.com/docs/api/list-classes.md) | List classes |
| [`POST /classes/suggest`](https://joinopenfile.com/docs/api/suggest-classes.md) | Suggest classes |

## Marks

| Endpoint | What it does |
| --- | --- |
| [`POST /marks/screen`](https://joinopenfile.com/docs/api/screen-mark.md) | Screen a mark |
| [`POST /marks/search`](https://joinopenfile.com/docs/api/search-marks.md) | Search USPTO records |
| [`POST /marks/alternatives`](https://joinopenfile.com/docs/api/suggest-alternatives.md) | Suggest alternative marks |

## Sites

| Endpoint | What it does |
| --- | --- |
| [`POST /sites/check`](https://joinopenfile.com/docs/api/check-site.md) | Check a company's trademarks |
| [`POST /sites/read`](https://joinopenfile.com/docs/api/read-site.md) | Read a website |

## Docs

| Endpoint | What it does |
| --- | --- |
| [`GET /docs/search`](https://joinopenfile.com/docs/api/search-docs.md) | Search the docs |
| [`GET /docs/read`](https://joinopenfile.com/docs/api/read-doc.md) | Read a docs page |

## Filing types

| Endpoint | What it does |
| --- | --- |
| [`GET /filing-types`](https://joinopenfile.com/docs/api/list-filing-types.md) | List filing types |
| [`GET /filing-types/{slug}`](https://joinopenfile.com/docs/api/get-filing-type.md) | Get a filing type |

## Applications

| Endpoint | What it does |
| --- | --- |
| [`POST /applications`](https://joinopenfile.com/docs/api/create-application.md) | Create an application |
| [`GET /applications/{id}`](https://joinopenfile.com/docs/api/get-application.md) | Get an application |
| [`PATCH /applications/{id}`](https://joinopenfile.com/docs/api/update-application.md) | Update an application |

## Filings

| Endpoint | What it does |
| --- | --- |
| [`GET /filings/{id}`](https://joinopenfile.com/docs/api/get-filing.md) | Get a filing |
| [`POST /filings/{id}/specimen`](https://joinopenfile.com/docs/api/add-specimen.md) | Add a specimen |

## Formation

| Endpoint | What it does |
| --- | --- |
| [`GET /states`](https://joinopenfile.com/docs/api/list-states.md) | List states |
| [`GET /states/{code}`](https://joinopenfile.com/docs/api/get-state.md) | Get a state |
| [`GET /services`](https://joinopenfile.com/docs/api/list-services.md) | List add-ons |
| [`POST /formations/quote`](https://joinopenfile.com/docs/api/quote-formation.md) | Quote a formation |
| [`POST /formations`](https://joinopenfile.com/docs/api/create-formation.md) | Create a formation |
| [`GET /formations/{id}`](https://joinopenfile.com/docs/api/get-formation.md) | Get a formation |
| [`PATCH /formations/{id}`](https://joinopenfile.com/docs/api/update-formation.md) | Update a formation |
| [`GET /orders/{id}`](https://joinopenfile.com/docs/api/get-order.md) | Get an order |