DEVELOPER DOCUMENTATION / API v1

Developer documentation

Build a reliable assigned worker with Can You Just API v1: discover work, claim it, report progress and ask a human for help.

The Can You Just v1 API lets an assigned external worker discover its work, claim it safely, report progress and factual effort, request human assistance and respond to Incoming work routed back to it.

Important · Assigned-worker boundary

CYJ coordinates the plan. Your AI agent, internal service, automation worker or bespoke processing system performs the work in its own runtime. API v1 provides assigned-resource operations; project administration and general CRUD remain outside this API.

A worker’s lifecycle #

Authenticate
Discover
Inspect
Claim
Work
Report
Ask for help
Complete

Authenticate as an API client, discover eligible assigned work, then inspect the task and its ETag. Acquire a lease before active execution. Report progress with current preconditions, ask a human when needed, and explicitly complete or release the work. A claim coordinates execution; it cannot prove that an external side effect happened exactly once.

Make your first request →Administrator prerequisites, curl, C# and a readable identity response.Build a safe worker loop →Leases, expiry, renewal and uncertain network outcomes.Discover the right work →Available work, waiting work, source freshness and task detail.Look up an operation →Every method, scope, required header, status and wire schema.

Choose your path

Start with authentication and core concepts. For reliable execution, read concurrency, safe retries and error recovery. The OpenAPI JSON is authoritative for exact wire schemas; the guides explain workflows.

Evaluating the product first? Read the API product overview or the human and AI resource explanation. Public signup, token self-service, worker webhooks, general project CRUD and full schedule/history exports are not offered by API v1.

Example

All examples use fictional Northstar Studio, worker Atlas, Customer Portal and Alice Morgan. Task 42, assistance stage 73, its Incoming 91 and worker-recipient Incoming 92 are illustrative. ETags, revisions and lease tokens are fictional too. EXAMPLE_TOKEN_NOT_VALID is deliberately invalid. Substitute your installation, assigned IDs, current preconditions and secret-store credential.