Get the task brief
/v1/integrate takes the endpoints you picked plus the job you're doing, and returns a task brief assembled from those endpoints' schemas, shared variables, and auth settings. It's the document you'd otherwise have reconstructed by hand from four doc pages.
- In the Orbit collection, add a second request named Get task brief, method POST, URL:
https://api.buildwithorbit.ai/ v1/ integrate- Open the Body tab, select raw → JSON, and paste the payload below. Note the
id: it's{{endpointUrn}}, not a pasted value. Postman substitutes your collection variable when the request is sent, so there's nothing to retype and nothing to get out of sync.
{ "task": "When a Deskly user books a desk, create a calendar event for that time slot", "resources": [ { "id": "{{endpointUrn}}", "type": "endpoint" } ]}- Open the Scripts tab, select After response, and paste the visualizer below. The brief lands in
data[0].taskBriefas one long plain-text string — hard to scan in Body. This script splits it into sections and renders them in the Visualization tab.
// Visualization Scriptconst response = pm.response.json();const taskBrief = response.data[0].taskBrief;// Split into sections by double newlineconst sections = taskBrief.split('\n\n');// Helper: render lines within a section bodyfunction renderLines(lines) { let html = ''; let inList = false; for (let i = 0; i < lines.length; i++) { const line = lines[i]; const trimmed = line.trim(); // Numbered step: starts with digit and dot/period- Save, then click Send. Expect a
200withdata[0].taskBrief. Orbit assembles the brief on demand rather than serving a cached page, so it can take a few seconds. - In the response pane, open the Visualization tab (next to Body). You should see the brief laid out in sections — FIT (whether these endpoints actually suit the task), AUTH (including which credentials you'd have to obtain), BASE URL, STEPS with parameters and expected responses, dependencies between steps, and important considerations.
Note what just happened: you now know what integrating this endpoint would cost you (which account, which credential, which request order), and you never left Postman or signed up for anything.
Troubleshooting: A 404 means endpointUrn doesn't hold a valid id. Open the collection's Variables tab and check it against your search response, in full and unedited. resources accepts 1 to 10 entries, so you can brief Orbit on several endpoints at once. The brief will cover how they chain together. If Visualization is empty, confirm the script is on Scripts → After response (not Before request), that you saved before sending, and that the response includes data[0].taskBrief.