Integrate Public Endpoints | Orbit by Postman

curl -X POST https://api.buildwithorbit.ai/v1/integrate \
     -H "Content-Type: application/json" \
     -d '{
  "task": "add shipment tracking and get basketball match realtime updates",
  "resources": [
    {
      "id": "1037111-50bc4c19-97d6-4c85-949d-59bd6f24503f",
      "type": "endpoint"
    },
    {
      "id": "1037111-6dcfabc1-ea9d-41e3-92ad-4f6b02ed4dbe",
      "type": "endpoint"
    }
  ]
}'

{
  "data": [
    {
      "taskBrief": "TASK BRIEF: Two independent calls supporting a weather-to-Slack app: retrieve London weather and post a message to Slack (OpenWeatherMap and Slack Web API)\nAUTH\n  OpenWeatherMap: API key supplied as the required `appid` query parameter; replace `YOUR_API_KEY` with the actual key.\n  Slack: bot token supplied in the `token` form field/header value as `{{bot_token}}`, requiring the `chat:write` scope. The Slack collection also specifies bearer authentication using the same `{{bot_token}}` credential; the request explicitly defines the `token` field.\n\nBASE URL\n  https://api.openweathermap.org  step 1\n  https://slack.com step 2\n\nSTEPS\n  1. GET /data/2.5/weather\n    Params:\n      q: required string query parameter `London`\n      appid: required string query parameter `YOUR_API_KEY` (replace with your OpenWeatherMap API key)\n    Returns:\n      No saved response example; the request is intended to return current weather data for the specified city.\n    Threading:\n      None\n\n  2. POST /api/chat.postMessage\n    Params (application/x-www-form-urlencoded body):\n      token: required string authentication field  `{{bot_token}}`\n      channel: required string `<string>` or a channel/private-group/IM channel identifier\n      text: string message text `test`; replace with the weather summary to post\n      Optional disabled fields include `as_user`, `attachments`, `blocks`, `icon_emoji`, `icon_url`, `link_names`, `mrkdwn`, `parse`, `reply_broadcast`, `thread_ts`, `unfurl_links`, `unfurl_media`, and `username`.\n    Returns:\n      HTTP 200 OK with JSON fields `ok` (boolean), `channel` (string), `ts` (string), and `message` (object). The message example includes `text`, `type`, and `ts`, plus optional attachments and blocks.\n    Threading:\n      None\n\nGOTCHAS\n  - Step 1 uses `appid` in the query string, not an authorization header.\n  - Step 2 must use `application/x-www-form-urlencoded`, not JSON."
    }
  ]
}

After selecting endpoints from /v1/search, send them to /v1/integrate along with the task you want to accomplish. It returns a task brief with the information and steps needed to call the selected endpoints.

Request

POST /v1/integrate

1 {
2   "task": "Build an app to post current weather to slack",
3   "resources": [
4         {
5             "id": "1446534-36e04f24-1a4e-4546-83c4-59049ae23f1b",
6             "type": "endpoint"
7         },
8         {
9             "id": "1037136-ac3a9a57-549d-4b73-b9fe-228aa65f75ab",
10             "type": "endpoint"
11         }
12     ]
13 }

task — what you want to accomplish (max 512 characters).
resources — the endpoints to integrate; each is an id from /v1/search plus its type (the result’s resourceType).

Both fields are required, and every resources entry needs id and type

This call takes no query parameters.

Response

The response contains one data entry with a taskBrief. The brief includes authentication requirements, base URLs, request steps, parameters, expected responses, dependencies between steps, and important considerations. The task brief uses the selected endpoints’ schemas and any shared variables, authentication settings, and descriptions defined by their parent APIs.

Errors

400 invalid input, 404 an id could not be resolved, 429 rate limited, 500 server error.

# Integrate Public Endpoints After selecting endpoints from `/v1/search`, send them to `/v1/integrate` along with the task you want to accomplish. It returns a **task brief** with the information and steps needed to call the selected endpoints. ## Request `POST /v1/integrate` ```json { "task": "Build an app to post current weather to slack", "resources": [ { "id": "1446534-36e04f24-1a4e-4546-83c4-59049ae23f1b", "type": "endpoint" }, { "id": "1037136-ac3a9a57-549d-4b73-b9fe-228aa65f75ab", "type": "endpoint" } ] } ``` - `task` — what you want to accomplish (max 512 characters). - `resources` — the endpoints to integrate; each is an `id` from `/v1/search` plus its `type` (the result's `resourceType`). Both fields are required, and every `resources` entry needs `id` and `type` This call takes no query parameters. ## Response The response contains one `data` entry with a `taskBrief`. The brief includes authentication requirements, base URLs, request steps, parameters, expected responses, dependencies between steps, and important considerations. The task brief uses the selected endpoints' schemas and any shared variables, authentication settings, and descriptions defined by their parent APIs. ## Errors `400` invalid input, `404` an `id` could not be resolved, `429` rate limited, `500` server error.

Request

This endpoint expects an object.

taskstringRequiredformat: "\S"1-512 characters

resourceslist of objectsRequired

Response

Successful Response

datalist of objectsOptional

Errors

400

Bad Request Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error

1	{
2	"task": "Build an app to post current weather to slack",
3	"resources": [
4	{
5	"id": "1446534-36e04f24-1a4e-4546-83c4-59049ae23f1b",
6	"type": "endpoint"
7	},
8	{
9	"id": "1037136-ac3a9a57-549d-4b73-b9fe-228aa65f75ab",
10	"type": "endpoint"
11	}
12	]
13	}