Quickstart

Prerequisites

You need:

an approved Arbol organization;
a bearer credential issued through your organization’s onboarding flow; and
the permissions required by the operation you call.

Registration and credentials are provisioned during onboarding. Do not put access tokens in source control, URLs, or logs.

Make a request

Set your credential

Export the credential in your shell without writing it to a file.

export ARBOL_ACCESS_TOKEN="your-access-token"

Read the production server from OpenAPI

The contract owns the base path, so derive it instead of hard-coding a path that can drift.

export ARBOL_API_BASE="$(
  curl --fail --silent https://api.getarbol.com/openapi.json \
    | jq --raw-output '.servers[0].url'
)"

List agents

Your credential must satisfy the security requirements shown for listAgents in the generated reference.

curl --fail-with-body \
  --header "Authorization: Bearer ${ARBOL_ACCESS_TOKEN}" \
  --header "Accept: application/json" \
  "${ARBOL_API_BASE}/agents?limit=10"

A successful paginated response contains items and nextCursor. When nextCursor is null, the collection has no next page.

{
  "items": [],
  "nextCursor": null
}

Next, read Authentication and Errors before adding mutation requests.

⌘I

Get started

Core concepts

API guides

Prerequisites

Make a request

​Prerequisites

​Make a request

Prerequisites

Make a request