Your progress is saved locally. to save it permanently.

0 of 3 steps0%
1

Create your Orbit workspace

Orbit needs no API key, but the collection you build against it still deserves its own home.

  1. Open the Postman desktop app. If you don't have it yet, download Postman and sign in (if you're already signed in, you're good to go).

  2. Click Workspaces in the top navigation → Create.

  3. On the Create your workspace form, in Workspace name enter [Your name] - Orbit (e.g. Alex - Orbit).

    text
    - Orbit
  4. For Select workspace type, select Internal.

  5. Leave the template on Blank workspace (already selected), then click Create Workspace.

Your new workspace opens with an empty sidebar.

Troubleshooting: If validation fails, check that the name ends with - Orbit (with the hyphen) and that you created the workspace yourself rather than joining someone else's.

2

Search for APIs by intent

Deskly's missing feature is "put the booking on a calendar." You don't need to know that Google Calendar, Zoom, and a handful of others expose that. You describe the capability and let Orbit map it to endpoints.

Create the collection

  1. Confirm you're in your Orbit workspace (check the name in the top-left).

  2. In the left sidebar, click + → Collection, and name it:

    Orbit

Add the search request

  1. Select the Orbit collection, click ⋯ → Add request.
  2. Name the request Search endpoints, set the method to POST, and paste this URL:
https://api.buildwithorbit.ai/v1/search?limit=5
  1. Open the Body tab, select raw → JSON, and paste:
json
{
"q": ""
}
  1. Save, then click Send.

What to look at in the response

Each entry in data carries the fields you need to make a decision:

FieldWhat it's for
idAn opaque urn:orbit:endpoint:v1:… identifier. You'll pass it back to Orbit verbatim in Part 2. Never edit or hand-build one.
resourceTypeThe kind of resource.
name, method, urlThe endpoint itself: what you'd call, and how.
provider, productWho publishes it (e.g. Google / Google Calendar).
evaluateGuideThe reason Orbit exists. Read it in the next step.

Query tip: q takes natural language, keywords, an API name, or a question, so both "create calendar event" and "an API to add an event to someone's calendar" work. Keep each call focused on one intent (add the provider name if you already know it, e.g. "PayPal create invoice") rather than cramming several asks into one query or joining them with OR. To explore two capabilities, send two requests.

Troubleshooting: q is the only body field Orbit accepts, adding anything else returns 400. A 429 means you're rate limited; wait a few seconds and send again.

3

Pick an endpoint using the evaluateGuide

evaluateGuide is three parts, newline-separated: a one-line summary, a Use for: list, and a Not supported: list. That last line is the one that stops you from integrating an endpoint for three days before discovering it can't do the one thing you needed.

  1. In your previous response, expand each entry's evaluateGuide. A calendar result reads roughly like "Creates an event on a specified calendar, letting an agent schedule a meeting with attendees and a time range. Use for: create calendar event, schedule meeting, add attendees. Not supported: recurring event expansion, free/busy lookup, calendar sharing."
  2. Read the Not supported: line on every candidate first, then the Use for: line. For Deskly you need to create an event for a known desk and time; anything that only reads availability is the wrong endpoint, however good its name looks.
  3. Pick the endpoint you'd hand to Deskly's engineers.
  4. Copy its id, the full urn:orbit:endpoint:v1:… string. You'll store it as a Postman variable next, so every request in this collection can reuse it without you retyping it.

Store it as a collection variable

  1. Select the Orbit collection, click the Variables tab.
  2. Add a new variable named endpointUrn, and paste the id into both the Value and Shared Value columns, then click Save, or press Cmd/Ctrl+S.

Copy the id whole: it's opaque, and a truncated URN won't resolve.

Heads up: Orbit's search isn't deterministic, the best-fit endpoint for a given query can differ from one run to the next as its catalog and ranking change. So the validator doesn't check for one "correct" id; it checks that endpointUrn exists on the collection and that the value resolves to a real, current endpoint in Orbit (a live call, not a static id). That's why it can take a few seconds.