Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.fieldnode.com/llms.txt

Use this file to discover all available pages before exploring further.

Fieldnode API is implemented as protobuf services exposed via Connect RPC, and every method is also available as REST. This means you can choose the integration style that fits your stack:
  • Use protobuf + Connect clients for strongly typed RPC workflows.
  • Use REST endpoints from the OpenAPI reference for plain HTTP integrations.

​
API model

  • Source of truth: Protobuf service definitions.
  • RPC transport: Connect protocol over HTTP.
  • REST transport: HTTP+JSON endpoints for the same methods.
  • Authentication: Same PAT bearer token flow for both transports.

​
Use SDKs from Buf

Fieldnode SDKs are published from the module page: Use that page as your primary source for language-specific installation and import instructions.

​
SDK workflow

  1. Open the Buf module page.
  2. Select your language SDK.
  3. Copy the install command shown for that SDK.
  4. Copy the usage snippet shown on the SDK page.
  5. Set the API base URL for your environment.
  6. Add your PAT bearer token to outgoing requests.
Each SDK is generated from the same protobuf services, so method names and request/response models are consistent across languages.

​
What to configure in every SDK integration

  • Environment base URL: use Development, Sandbox, or Production.
  • Authorization header: Authorization: Bearer pat_<your_token>.
  • Timeouts/retries: configure client defaults for network resiliency.
  • Error handling: handle standard HTTP status codes and error responses.
When you use an SDK, calls are made as typed service methods over Connect RPC instead of manually constructing REST JSON requests.

​
Use the REST endpoints

If you prefer plain HTTP/JSON:
  • Use the API Reference section in these docs (generated from OpenAPI).
  • Locate the endpoint for the method you need.
  • Call it with your PAT bearer token as shown in authentication.
REST and RPC are equivalent at the method level. You can mix them in one integration if needed.