Getting Started — Wahlu API Docs

What is the Wahlu API?

The Wahlu API provides 15 operations for agents and applications. Its thirteen-operation preparation subset discovers accessible context and targets, uploads, imports, inspects, and explicitly repairs media, creates a draft, discovers live TikTok privacy choices, updates that choice on the same draft, preflights it, and creates and reads a Schedule; the full contract also exposes redacted publish receipts and exact receipt-bound cleanup.

Base URL

Every public REST route in this reference starts with:

https://api.wahlu.com/v1

Quick start

1. Create an API key

Open your Wahlu dashboard, go to Settings → API Keys, and create a key. Choose only the scopes your workflow needs and, if appropriate, restrict it to specific brands.

2. Discover the current context

Start every agent workflow by reading the workspace, accessible brands, granted scopes and resolved next-operation links for the current key.

curl

curl https://api.wahlu.com/v1/context \
  -H "Authorization: Bearer wahlu_live_your_api_key_here"

JavaScript

const response = await fetch("https://api.wahlu.com/v1/context", {
  headers: {
    Authorization: "Bearer wahlu_live_your_api_key_here",
  },
});

if (!response.ok) throw new Error("Wahlu returned " + response.status);

const { data, meta } = await response.json();
console.log(data.brands, data.api_key.scopes, meta.request_id);

3. Follow returned links and IDs

A successful response uses the strict canonical envelope below. Use the returned brand ID and links rather than constructing or guessing identifiers.

200 response

{
  "success": true,
  "data": {
    "actor": { "user_id": "user_01k0agent" },
    "workspace": { "id": "workspace_01k0acme", "name": "Acme Social" },
    "api_key": {
      "id": "api_key_01k0agent",
      "name": "Content agent",
      "scopes": [
        "integrations:read",
        "media:read",
        "media:write",
        "posts:write",
        "schedule:read",
        "schedule:write"
      ],
      "brand_access": "restricted",
      "brand_ids": ["brand_01k0acme"]
    },
    "brands": [
      {
        "id": "brand_01k0acme",
        "name": "Acme",
        "links": {
          "targets": {
            "href": "/v1/brands/brand_01k0acme/targets",
            "required_scopes": ["integrations:read"]
          },
          "media_imports": {
            "href": "/v1/brands/brand_01k0acme/media/imports",
            "method": "POST",
            "required_scopes": ["media:write"]
          },
          "content_items": {
            "href": "/v1/brands/brand_01k0acme/content-items",
            "method": "POST",
            "required_scopes": ["posts:write"]
          }
        }
      }
    ],
    "links": {
      "platform_capabilities": {
        "href": "/v1/platforms/capabilities",
        "required_scopes": []
      }
    }
  },
  "meta": { "request_id": "req_context_01k0" }
}

Recommended first workflow

Use the held Schedule recipe for the core eleven-operation no-provider workflow. When the selected target is TikTok, first read its live privacy choices and apply one validated value to the same draft before preflight. That discovery step is a provider-backed read, but it creates no Wahlu resource or provider post. The full public API also exposes bounded publish receipt and exact provider cleanup operations after a run. The recipe finishes with a pending_review Schedule and creates no publishing execution, job or provider request.