For AI agents: a machine-readable documentation index for this API is available at /llms.txt. Every page is also available as Markdown — append ".md" to the URL or send an "Accept: text/markdown" request header.

Update project use cases

Review existing use cases for a project and update them, or create new ones.

Manage the use cases published for a project. Start by listing what already exists, then edit any entry in place or add a fresh one when a capability is missing.

Reach for this when a project's documented use cases have drifted from the current API, or when you want to seed a project with example content and refine it over time.

Steps

Restless runs these seven in order with your stored key, and stops for your approval before each one that changes data.
  1. 1

    Confirm the identity and access behind the API key with GET /api/v1/me.

  2. 2

    Pick the target project. If you only have an example slug, verify it with GET /api/v1/projects/{slug}, or browse options via GET /api/v1/projects.

  3. 3

    List the current use cases for the project with GET /api/v1/projects/{slug}/usecases. Note the usecaseSlug of each entry.

  4. 4

    To update an existing use case in place, send the revised fields to PATCH /api/v1/projects/{slug}/usecases/{usecaseSlug}. It accepts title, description, icon, content, docsBody, public, and asTool, and leaves anything you omit untouched.

    changes data
  5. 5

    To add a new use case, create it with POST /api/v1/projects/{slug}/usecases. It accepts the same fields as the update, so a complete use case can be created in one call. Only title is required, and public and asTool both default to true unless you pass false.

    changes data
  6. 6

    Note what each body field is for, since three of them read like descriptions and are not interchangeable. description is the one-line excerpt on the card. docsBody is the prose write-up shown on the public docs, and is paired with public. content is the step-by-step, agent-facing walkthrough returned by the MCP tool, names real endpoints, and is paired with asTool.

  7. 7

    Re-run GET /api/v1/projects/{slug}/usecases to confirm the changes landed.