API Studio

API Studio

API Studio is where you design the APIs your account offers. Each API is described by an OpenAPI document, kept in versions, and shown as endpoints and schemas.

Open API Studio in the top bar. The menu on the left opens APIs, Clients and Policies. APIs lists every API in the account with its Name, Type (REST or OData), Latest version and Status (Draft or Published). Search APIs filters the list by name. Import and New API are at the top of the page.

Who can use it

Role	What they can do
Viewer, Auditor	Open APIs, read their documents, endpoints and schemas, and export them.
Builder	Everything above, plus create APIs, edit drafts, import documents and start new drafts.
Admin, Owner	Everything above, plus publish versions.

Create an API

Press New API. The dialog has three steps: Type and template, Basics and Review. Press Continue to move on and Back to change an earlier step.

1. On Type and template, choose the Type: REST or OData. Under Start from, choose:
   • Blank: an empty document.
   • Resource CRUD: list, create, read, replace, update and delete for one resource.
   • Query and filter: a list endpoint with filter and sort.
   • Cursor pagination: a list endpoint that pages with a cursor.
   • Long-running operation: a request that returns at once and is polled for its result.
   • From a connection: listed when the account has a connection that can describe its objects.
   • Describe the API: Milo drafts the document from one sentence.
2. On Basics, enter a Name. For a template, enter the Resource name, a plural noun used in the paths, such as orders.
3. On Review, check your choices and press Create API. The API opens with its first draft version.

From a connection

1. Choose From a connection.
2. Choose the Connection and enter the Object, such as Account.
3. Press Load fields. The dialog shows how many fields it found.
4. Press Create API.

The new API has a schema with one property per field and the Resource CRUD operations.

Describe the API

1. Choose Describe the API.
2. Enter a Description of 5 to 500 characters, such as "An API for booking meeting rooms".
3. On Review, press Draft API.

Milo names the API and saves a draft for you to review. Milo never publishes. Each draft uses AI credits.

To start from a document you already have, press Import instead. See Import and export.

Versions and stages

An API opens on its newest version. The Version list at the top switches between versions. A draft can be edited; a published version is read only. See Publishing and versions.

Beside the version list are the More actions menu, with Import, Export and New draft, and one main button that fits the version: Publish on a draft, Deploy version on a published version and New client in Operate.

The page is split into stages. Each stage shows a short status, such as "5 endpoints" or "v2 in Dev and Test".

• Overview: the Next step for the API, with one button that opens it, and the version each environment serves.
• 1 Design:
  • Designer: the OpenAPI document in a code editor or the visual designer, with its problems beside it. See Designing an API and Visual designer.
  • Endpoints: one row per method and path, with its Implementation, Sample responses or Flow, and its Mode. See API Request and API Response flows.
  • Schemas: each schema under components.schemas, with its definition and an example.
  • Docs: the rendered reference docs and a download for each export format. See Reference docs.
• 2 Test:
  • Try it: send one request. See Testing with Sample responses.
  • Test suites: saved and generated test cases. See Testing an API.
• 3 Deploy: the version each environment serves, promotion, roll back and history. See Deploying an API.
• 4 Operate:
  • Access: clients and keys per environment. See Clients and keys.
  • Analytics: calls, errors and latency. See API analytics.

The selected stage, section and version are part of the page address, so a link opens the same view. Links saved before the stages still open the matching section.

Without the API Studio add-on

An account without the API Studio add-on keeps one draft API and cannot publish. Contact your account owner to add it.

When API Studio is not available

When API Studio is turned off for the platform, its menu item is hidden, its pages show "Not available" and deployed APIs do not answer calls. Contact DataLug support to turn it on.