# Restless

> Machine-readable index for the Restless API. Each endpoint below links to a Markdown reference (with its OpenAPI slice inlined). The full narrative docs and the complete spec are linked under Reference. Written for agents, not human skimming.

# MCP Server

There's an MCP server at `https://build.restless.ai/mcp` exposing tools like `search_endpoints`, `get_endpoint`, and operation lookup. When you need specifics about an endpoint - parameters, status codes, examples - query the MCP server first; do not guess.

If the user has not yet connected the MCP server in their client, they can install it from the docs at `https://build.restless.ai`.

# Reference

- [Full documentation](https://build.restless.ai/llms-full.txt): every endpoint, auth, SDKs, and guides inlined as one document.
- The complete OpenAPI spec (internal operations removed) is available at `https://build.restless.ai/openapi.yaml`.

# Installation

- [Use with Claude](https://build.restless.ai/installs/claude.md) - connect Claude to the API over MCP, with a paste-ready prompt
- [Use with ChatGPT](https://build.restless.ai/installs/chatgpt.md) - connect ChatGPT to the API over MCP, with a paste-ready prompt
- [Install the CLI](https://build.restless.ai/installs/cli.md) - install the command-line tool, with an agent setup prompt and common commands
- [Set up with Node.js](https://build.restless.ai/installs/node.md) - install steps and an agent setup prompt for Node.js
- [Set up with Python](https://build.restless.ai/installs/python.md) - install steps and an agent setup prompt for Python
- [Set up with Ruby](https://build.restless.ai/installs/ruby.md) - install steps and an agent setup prompt for Ruby
- [Set up with PHP](https://build.restless.ai/installs/php.md) - install steps and an agent setup prompt for PHP
- [Set up with Go](https://build.restless.ai/installs/go.md) - install steps and an agent setup prompt for Go
- [Set up with React](https://build.restless.ai/installs/react.md) - install steps and an agent setup prompt for React
- [Set up with Java](https://build.restless.ai/installs/java.md) - install steps and an agent setup prompt for Java
- [Set up with C#](https://build.restless.ai/installs/csharp.md) - install steps and an agent setup prompt for C#
- [Set up with Rust](https://build.restless.ai/installs/rust.md) - install steps and an agent setup prompt for Rust
- [Any other language](https://build.restless.ai/installs/other.md) - a generic prompt for calling the API from any language

# Use cases

Curated tasks this API supports, each written as the calls to make in order.

- [Update project use cases](https://build.restless.ai/usecases/update-project-use-cases.md) - Review existing use cases for a project and update them, or create new ones.
- [Update the getting started page](https://build.restless.ai/usecases/update-the-getting-started-page.md) - Review and update the project's getting started documentation page.
- [Triage a spike in failed requests](https://build.restless.ai/usecases/triage-a-spike-in-failed-requests.md) - Find what is behind a jump in errors and read the request that proves it.
- [Find customers about to churn on errors](https://build.restless.ai/usecases/find-customers-about-to-churn-on-errors.md) - Surface the end-users whose error rate is climbing, then read what is failing for them.
- [Turn agent feedback into a docs fix](https://build.restless.ai/usecases/turn-agent-feedback-into-a-docs-fix.md) - Read what confused a machine consumer of the API, fix the docs, then close the note out.
- [Write a recovery message for a recurring error](https://build.restless.ai/usecases/write-a-recovery-message-for-a-recurring-error.md) - Attach next-step guidance to an error agents keep hitting, so it comes back with the failure.
- [Explain why a user got stuck, then close the gap](https://build.restless.ai/usecases/explain-why-a-user-got-stuck-then-close-the-gap.md) - Find out why someone got stuck by reading their own traffic, then fix the cause.

# Endpoints

Base URL: `https://app.restless.ai`

- [Identity behind the API key](https://build.restless.ai/endpoint/get-api-v1-me.md) - `GET https://app.restless.ai/api/v1/me`
- [List accessible projects](https://build.restless.ai/endpoint/get-api-v1-projects.md) - `GET https://app.restless.ai/api/v1/projects`
- [Get one project](https://build.restless.ai/endpoint/get-api-v1-projects-slug.md) - `GET https://app.restless.ai/api/v1/projects/{slug}`
- [Search request logs](https://build.restless.ai/endpoint/get-api-v1-projects-slug-logs.md) - `GET https://app.restless.ai/api/v1/projects/{slug}/logs`
- [Get one log (audited)](https://build.restless.ai/endpoint/get-api-v1-projects-slug-logs-logid.md) - `GET https://app.restless.ai/api/v1/projects/{slug}/logs/{logId}`
- [List end-users (or at-risk users)](https://build.restless.ai/endpoint/get-api-v1-projects-slug-users.md) - `GET https://app.restless.ai/api/v1/projects/{slug}/users`
- [Top endpoints (optionally with error rates)](https://build.restless.ai/endpoint/get-api-v1-projects-slug-endpoints.md) - `GET https://app.restless.ai/api/v1/projects/{slug}/endpoints`
- [Time-series aggregation (or filter values)](https://build.restless.ai/endpoint/get-api-v1-projects-slug-metrics.md) - `GET https://app.restless.ai/api/v1/projects/{slug}/metrics`
- [Get docs portal settings](https://build.restless.ai/endpoint/get-api-v1-projects-slug-docs.md) - `GET https://app.restless.ai/api/v1/projects/{slug}/docs`
- [Update docs portal settings](https://build.restless.ai/endpoint/patch-api-v1-projects-slug-docs.md) - `PATCH https://app.restless.ai/api/v1/projects/{slug}/docs`
- [Get docs content](https://build.restless.ai/endpoint/get-api-v1-projects-slug-content.md) - `GET https://app.restless.ai/api/v1/projects/{slug}/content`
- [Update docs content](https://build.restless.ai/endpoint/patch-api-v1-projects-slug-content.md) - `PATCH https://app.restless.ai/api/v1/projects/{slug}/content`
- [List members + invites](https://build.restless.ai/endpoint/get-api-v1-projects-slug-members.md) - `GET https://app.restless.ai/api/v1/projects/{slug}/members`
- [Invite a member](https://build.restless.ai/endpoint/post-api-v1-projects-slug-members.md) - `POST https://app.restless.ai/api/v1/projects/{slug}/members`
- [Remove a member or revoke an invite](https://build.restless.ai/endpoint/delete-api-v1-projects-slug-members.md) - `DELETE https://app.restless.ai/api/v1/projects/{slug}/members`
- [List use cases](https://build.restless.ai/endpoint/get-api-v1-projects-slug-usecases.md) - `GET https://app.restless.ai/api/v1/projects/{slug}/usecases`
- [Create a use case](https://build.restless.ai/endpoint/post-api-v1-projects-slug-usecases.md) - `POST https://app.restless.ai/api/v1/projects/{slug}/usecases`
- [Update a use case](https://build.restless.ai/endpoint/patch-api-v1-projects-slug-usecases-usecaseslug.md) - `PATCH https://app.restless.ai/api/v1/projects/{slug}/usecases/{usecaseSlug}`
- [Delete a use case](https://build.restless.ai/endpoint/delete-api-v1-projects-slug-usecases-usecaseslug.md) - `DELETE https://app.restless.ai/api/v1/projects/{slug}/usecases/{usecaseSlug}`
- [List context items](https://build.restless.ai/endpoint/get-api-v1-projects-slug-context.md) - `GET https://app.restless.ai/api/v1/projects/{slug}/context`
- [Create a context item](https://build.restless.ai/endpoint/post-api-v1-projects-slug-context.md) - `POST https://app.restless.ai/api/v1/projects/{slug}/context`
- [Update a context item](https://build.restless.ai/endpoint/patch-api-v1-projects-slug-context-contextslug.md) - `PATCH https://app.restless.ai/api/v1/projects/{slug}/context/{contextSlug}`
- [Delete a context item](https://build.restless.ai/endpoint/delete-api-v1-projects-slug-context-contextslug.md) - `DELETE https://app.restless.ai/api/v1/projects/{slug}/context/{contextSlug}`
- [List recovery messages](https://build.restless.ai/endpoint/get-api-v1-projects-slug-recovery.md) - `GET https://app.restless.ai/api/v1/projects/{slug}/recovery`
- [Create/update a recovery message](https://build.restless.ai/endpoint/post-api-v1-projects-slug-recovery.md) - `POST https://app.restless.ai/api/v1/projects/{slug}/recovery`
- [Delete a recovery message](https://build.restless.ai/endpoint/delete-api-v1-projects-slug-recovery.md) - `DELETE https://app.restless.ai/api/v1/projects/{slug}/recovery`
- [List data sources](https://build.restless.ai/endpoint/get-api-v1-projects-slug-data-sources.md) - `GET https://app.restless.ai/api/v1/projects/{slug}/data-sources`
- [Connect a GitHub repo](https://build.restless.ai/endpoint/post-api-v1-projects-slug-data-sources.md) - `POST https://app.restless.ai/api/v1/projects/{slug}/data-sources`
- [Update a data source](https://build.restless.ai/endpoint/patch-api-v1-projects-slug-data-sources.md) - `PATCH https://app.restless.ai/api/v1/projects/{slug}/data-sources`
- [Disconnect a data source](https://build.restless.ai/endpoint/delete-api-v1-projects-slug-data-sources.md) - `DELETE https://app.restless.ai/api/v1/projects/{slug}/data-sources`
- [Re-ingest a documentation source](https://build.restless.ai/endpoint/post-api-v1-projects-slug-data-sources-sourceid-sync.md) - `POST https://app.restless.ai/api/v1/projects/{slug}/data-sources/{sourceId}/sync`
- [Get MCP tool catalog + config](https://build.restless.ai/endpoint/get-api-v1-projects-slug-mcp-tools.md) - `GET https://app.restless.ai/api/v1/projects/{slug}/mcp-tools`
- [Update MCP tool catalog config](https://build.restless.ai/endpoint/patch-api-v1-projects-slug-mcp-tools.md) - `PATCH https://app.restless.ai/api/v1/projects/{slug}/mcp-tools`
- [List API feedback from agents](https://build.restless.ai/endpoint/get-api-v1-projects-slug-feedback.md) - `GET https://app.restless.ai/api/v1/projects/{slug}/feedback`
- [Triage one piece of API feedback](https://build.restless.ai/endpoint/patch-api-v1-projects-slug-feedback-feedbackid.md) - `PATCH https://app.restless.ai/api/v1/projects/{slug}/feedback/{feedbackId}`