Editing endpoints

Each endpoint in your spec gets a reference page, with its parameters, request body, responses and code samples. Everything the spec provides is filled in for you, and you can improve any of it in API Studio.

Editing a page

Select an endpoint in the navigation. Edit its Description, and write the body in Visual or MDX mode. The spec remains the source for its parameters and schemas.

Your edits are a draft until you publish, and they survive importing a new version of the spec.

Code samples

Request code in the side panel shows how to call the endpoint in each language you generate an SDK for. To use your own, add a language sample and give it a display name. You can add cURL, Shell, JavaScript, TypeScript, Python, Java, Kotlin, PHP, Ruby, Rust, Swift, Dart and JSON.

Generating descriptions

The generate dialog can write endpoint content for you. Choose which endpoints:

• Only endpoints with nothing written yet. Fills the gaps and leaves your work alone.
• Every endpoint, rewriting what is there. Starts again, replacing what you have.

On a single endpoint, you can rewrite This page only. Generating uses AI credits.

Adding an endpoint

You can add an operation before it exists in your spec.

1. Choose New endpoint

   Pick the method and path. Path parameters go in braces, like /users/{id}.

2. Describe it

   Add a summary and, if you like, a description.

3. Publish

   Publishing adds it to your spec as a new version. Its responses, examples, SDK methods and MCP tool are generated then.

Until then it is marked New endpoint, not published yet, and nothing outside the studio can see it. Choose Discard endpoint if you change your mind.

Marking one deprecated

Choose Mark deprecated and add a note saying what to use instead. Readers see the notice once you publish, and the generated SDK method carries it from there too.

If an endpoint was marked deprecated in SDK Studio, API Studio shows that mark but can't clear it. Clear it in SDK Studio.

Hiding an endpoint

Hide a row in the navigation to keep it out of the published docs. This is the one visibility every product shares: a hidden endpoint also leaves the SDKs and MCP tools. See how products share an endpoint.

Deleting an endpoint

Choose Delete endpoint. It leaves your spec on the next publish, with its page, SDK methods and MCP tool. Until then it is marked Deleted when you publish, and Keep endpoint undoes it.

Plans and coverage

A plan with an endpoint limit documents the first endpoints in your spec, in spec order, that nobody has hidden. Hiding one pulls in the next. See plans and limits.

Keeping GitHub in step

If your spec lives in GitHub, Octri can commit your endpoint changes back to the repository. See GitHub sync.

From the CLI

Draft endpoints can be added, edited, removed, discarded and published with octri docs endpoints.