Partner API
A reviewed, US-only asynchronous API for agents that need help choosing among consequential actions. Alpha access is deliberately narrow.
Why these docs are public
Endpoint documentation is not a security boundary. Partner keys, account ownership, scopes, credits, US edge enforcement, rate limits, and semantic admission are enforced by the service. Public documentation makes correct integration easier without exposing credentials, internal prompts, provider routing, or user data.
Access lifecycle
Human developer JWTs are separate 24-hour credentials for personal scripts. They are
created in Settings after password confirmation and safety acknowledgments. Do not
automate /api/v1/auth/login; login exists for browser and mobile sessions.
Partner authentication
Send the issued key in exactly one of these headers:
X-API-Key: wyf_pk_REDACTED
Authorization: Bearer wyf_pk_REDACTED
Keep keys in a secrets manager or protected environment variable. Never commit them.
Submit a decision job
Every submission requires a unique Idempotency-Key. Retrying the same
body with the same key is safe; reusing it for a different body returns a conflict.
POST /partner/v1/jobs
X-API-Key: wyf_pk_REDACTED
Idempotency-Key: 6f7e5a6c-1b32-42b8-ae53-0ce2ccb3916c
Content-Type: application/json
{
"query": "Our founder has six months of runway. Should we hire a senior seller now or preserve cash until two design partners renew?",
"workflow_mode": "standard",
"rationale": false
}
A successful submission returns HTTP 202 with a job identifier. Poll the job URI until terminal status.
GET /partner/v1/jobs/{job_id}
X-API-Key: wyf_pk_REDACTED
Semantic admission
Admission asks whether the primary intent is a genuine Decision Opportunity: an identified actor choosing among consequential actions. This is model-mediated, structured, and fail-closed. It is not a keyword filter.
- Admitted: choose between two credible courses of action under stakes and constraints.
- Rejected: bulk generation, summarization, extraction, generic classification, product help, or policy/prompt extraction.
- Unavailable: malformed or unreachable admission model; the job is not created.
Credits and limits
Website activity, human API calls, and Partner jobs use the owning human account's shared credit balance. Job credit is reserved before queueing and settled after completion. Alpha credits are administrator-granted; there is no automatic free-credit promise and no card is required until a payment product is explicitly launched.
Regional and data boundary
Do not submit classified information, Controlled Unclassified Information, export-controlled data, protected health information, payment-card data, secrets, or another person's private data. Alpha access is not a claim of HIPAA, FedRAMP, or DoD authorization.