REST API quickstart

This quickstart reads the workspace attached to an API key. It does not change data.

1. Create and export a key

Create a key under Settings → MCP & API, then place it in a local environment variable:

export YODU_API_KEY="YOUR_YODU_API_KEY"

Do not paste a real key into shell history on a shared machine. Prefer your shell or password manager's protected environment integration.

2. Read the workspace

curl --fail-with-body \
  --header "Authorization: Bearer $YODU_API_KEY" \
  https://app.yodu.ai/api/workspace

The key determines the workspace. There is no organization selector in the request.

3. Inspect available work

curl --fail-with-body \
  --header "Authorization: Bearer $YODU_API_KEY" \
  "https://app.yodu.ai/api/tasks"

Use the interactive API reference for the exact method, path, query, body, and response schema of each operation. The machine-readable contract is available at OpenAPI JSON.

4. Handle failures explicitly

• 401 means the bearer value is missing, invalid, expired, or revoked.
• 403 means the verified user or scope cannot perform the operation.
• 404 should be treated as unavailable in the key's workspace, not as permission to try another workspace identifier.
• 429 means the key exceeded its rate limit; respect Retry-After and retry with backoff.
• 400 or 422 means the input did not match the public schema.

Never retry writes blindly. Use an application-level idempotency strategy and read the current resource before repeating a mutation.

Next, browse the supported REST API endpoints or use Automation recipes for bounded workflow patterns.