Skip to main content

Source

A provider or source group in GET /v2/sources. A directory entry can be discovery-only. available_in_v2 and readiness show whether at least one operation is currently executable.

Service and operation

A provider may publish several services, each with several endpoints. A currently executable endpoint appears as an operation in GET /v2/sources/, with its input fields, capability and price. Pulse Network is one provider group with nested services.

Ask, plan, and run

An Ask is a question in a person’s words. A plan shows source steps and one total price ceiling before purchase. A run is the saved execution, including results, charges, held funds and errors. Planning is free; a plan’s quote expires.

Organisation and workspace

An organisation has members, a main balance and API keys. A workspace is a team area with its own members and budget. Organisation API keys spend the main balance; people and assistant connections can spend a workspace budget.

API key and connection

An API key (apk_org_live_…) is a server credential with permissions, expiry, a per-request limit and a monthly limit. A connection is consent granted by a person to an assistant, with a per-request and daily limit.

Micro-USD

One millionth of a US dollar. API money objects carry a decimal amount and an exact integer string amount_micro_usd.