Agent Builder

Create agent schedule

Creates an organization-scoped schedule under a non-archived Agent Builder definition.

POSTNeeds publication reviewLocal writeAgent BuilderoperationId: createAgentBuilderSchedulehttps://dev-api.quickintell.com/api/v1/agent-builder/definitions/{agentId}/schedules

Needs publication reviewLocal writeAgent Builder and Prevention

Route status

Needs publication review

The endpoint contract is visible, but QuickRCM has not approved it yet for normal production API use.

Publication status

Needs publication review

Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use. Also requires E2 side-effect policy before production recipes, SDK inclusion, or try-out access.

Authentication

Bearer API key declared

OpenAPI declares bearer API-key security for this operation.

Tenant context

API-key organization

API-key organization context is authoritative; request organizationId is not a public tenant selector.

Side-effect summary

Local write

May mutate QuickRCM records. It does not prove live payer, EHR, clearinghouse, payment, or communication execution.

Source artifact

docs/openapi/openapi.json

OpenAPI 3.1.0; API 1.0.0.

When to use this endpoint

Use this page as an internal baseline for the agent builder and prevention contract generated for POST /api/v1/agent-builder/definitions/{agentId}/schedules. External use still depends on route classification, release evidence, and endpoint-specific side-effect approval.

What this does now

Shows the generated OpenAPI shape for POST /api/v1/agent-builder/definitions/{agentId}/schedules, but keeps the route out of ordinary production API positioning until review is complete.

What this does not do

Does not prove external GA readiness, SDK readiness, live production execution, or complete module behavior. Mutating behavior still needs side-effect and retry evidence.

Not public from this page

Do not publish this endpoint as an ordinary developer API until its unresolved decisions are closed.

Headers and tenancy

Current headers and tenant authority. Target headers stay labeled as future until OpenAPI and release evidence declare them.

Header	Required	Current status	Notes
Authorization	Yes	Current	Bearer <QUICKRCM_API_KEY>. OpenAPI security: bearerAuth.
Idempotency-Key	No	Target/future	Do not claim universal header support until E3 and OpenAPI metadata exist.
X-Request-Id	No	Target/future	Use for support correlation only after approved; not declared as a standard OpenAPI header today.

Required scopes

Unclassified until E6 route metadata exists; do not infer scopes from route names.

Wrong-org behavior

Tenant-safe 404, empty list, or 403 is endpoint-specific and remains an evidence gap until E1 is closed.

Actor and audit

No public actor, audit, or correlation contract is published from OpenAPI alone.

Idempotency and retries

Retry behavior is documented conservatively because universal idempotency headers are not declared.

Topic	Status	Guidance
Current idempotency	No idempotency mechanism is declared.	Do not retry blindly. Check resource, status, batch, or job state before repeating the request.
Universal header	Not declared	Do not document universal Idempotency-Key support until OpenAPI and E3 evidence declare it.
Conflict behavior	Unresolved	Same-key changed-payload, in-flight retry, fingerprint scope, and TTL behavior remain endpoint-specific evidence gaps.

Async jobs and polling

Queued work is accepted work, not proof of completed workflow execution.

Topic	Status	Guidance
Immediate response	No 202 response declared	OpenAPI does not declare HTTP 202 for this operation.
Polling and terminal states	Not indicated by OpenAPI	No generic polling contract is published from this page.
Later side effects	Not proven	Do not infer background execution beyond the documented response.

Files and artifacts

File-like routes need content-class, ownership, scanning, retention, and URL policy evidence before public recipes.

Topic	Status	Guidance
Content class	No file/artifact class inferred	OpenAPI text does not indicate file or artifact handling for this endpoint.
Ownership and storage keys	Not applicable unless a file field is present	Tenant ownership must be proven before retrieval or upload docs. Never expose storage keys as public identifiers.
URLs, scanning, and retention	Unresolved unless endpoint-specific evidence exists	Short-lived URLs, MIME limits, checksums, scanner status, retention, expiration, and legal hold behavior are not implied by OpenAPI examples.

Publication warnings

This endpoint needs explicit product, security/compliance, tenancy, or side-effect approval before publication.
Universal Idempotency-Key header support is not declared; retry only after checking endpoint-specific state.

Related platform rules

Workflow Guide Route Status Tenant Context Errors Rate Limits PHI and Security Publication Readiness Side-Effect Modes Idempotency

Evidence

Evidence	Status	Caveat
OpenAPI artifact	docs/openapi/openapi.json; OpenAPI 3.1.0; API 1.0.0.	Generated baseline contract only.
Route registry	Needs publication review from documentation classification overlay.	E6 route registry evidence is still required before external publication.
Example validation	Generated examples are internal baseline aids.	No external publication claim; examples must pass no-PHI/no-secret/no-raw-payload/no-storage-key checks.
Last reviewed	Implementation run 20260619T-docs-impl; source boardroom packet 20260619T064820Z.	Refresh this evidence for release workspaces.
Release evidence	E9 required.	No SDK readiness, production readiness, or expanded external docs claim from this endpoint page.

Agent Builder public API.

Agent Builder public API endpoints let an authenticated tenant integration manage visual robotic process automation (RPA) agent definitions, schedules, safe execution wrapper records, credential discovery metadata, and reusable templates. These endpoints are intentionally conservative: definition and schedule responses return safe metadata, template responses omit step bodies, credential responses omit stored usernames and secrets, and execution create/retry responses expose `dryRun`, `queueOnly`, and `browserAutomationStarted` safety controls instead of starting browser automation inline. Use these endpoints to configure and monitor organization-scoped automation around payer, electronic health record (EHR), clearinghouse, government, lab, pharmacy, registry, or custom portals. Do not send real protected health information (PHI), raw portal payloads, credentials, electronic data interchange (EDI) files, transcripts, or storage keys in examples or logs. Treat `inputParams`, `steps`, extraction schemas, schedule secrets, and execution output as sensitive workflow configuration. Public read endpoints require Agent Builder read access; public write endpoints require the relevant Agent Builder automation write/admin permission, role-based access control (RBAC), and organization ownership checks.

What this endpoint does

Use case

Use this when an agent definition should be run later by cron, interval, event, webhook, manual, or dependency-triggered scheduling.

Before calling

Confirm the `agentId` belongs to the organization and is not archived. Resolve credential and dependency schedule IDs from the same organization.

Request and response behavior

Request guidance

`CRON` schedules require `cronExpression`; `INTERVAL` schedules require `intervalMinutes`. Avoid placing PHI, secrets, raw payer payloads, or portal credentials in `inputParams`, `webhookSecret`, or alert fields.

`name` is optional and capped at 200 characters when provided.
`timezone` defaults to `America/New_York` when omitted.
`maxConcurrentRuns` defaults to 1 and is constrained to 1-50.
`retryOnFailure` defaults to true, `maxRetries` defaults to 3, `priority` defaults to `NORMAL`, `alertOnFailure` defaults to true, `alertEmails` defaults to an empty list, `pauseAfterFailures` defaults to 3, and `isActive` defaults to true.
Create/update schedule can accept a caller-provided `webhookSecret`, but create/update responses do not return it; use the rotate endpoint to generate and display a new secret once.

Response semantics

A 201 response creates schedule metadata and returns `SAFE_WRITE_DB_ONLY`. The response omits `webhookSecret`, `inputParams`, credential linkage, retry settings, alert emails, and blackout details.

`nextRunAt` is computed for CRON schedules when the API can calculate it.
Schedule creation does not itself create an execution.

Errors and retries

Fix validation errors before retrying. A 400 can indicate an archived agent, missing trigger-specific field, invalid cron expression, bad credential, or missing dependency schedule.

404 means the agent definition was not found in the authenticated organization.
400 can mean the referenced credential is inactive, locked, missing, or belongs to another organization.

Template boundary before examples

The route class, authentication state, tenancy rule, side-effect mode, idempotency status, async behavior, file policy, warnings, links, and evidence above are part of the endpoint contract. Treat generated examples below as internal baseline aids until release evidence closes.

Path parameters

Name	Location	Required	Type	Description	Validation and safety notes
agentId	path	Yes	string	Path ID of the definition that owns the new schedule.	Minimum length: 1.

Query parameters

This endpoint does not define query parameters.

OpenAPI-declared header parameters

Standard platform header guidance appears in the governance panel. This table only lists operation-specific headers declared in OpenAPI.

This endpoint does not define operation-specific header parameters.

Request body

JSON fields from the generated OpenAPI schema with pilot enrichment applied where available. Nested object fields are shown with dotted paths.

Name	Location	Required	Type	Description	Validation and safety notes
name	body	No	string	Optional schedule display name, 1-200 characters when provided.	Minimum length: 1. Maximum length: 200.
triggerType	body	Yes	CRON \| INTERVAL \| EVENT \| WEBHOOK \| MANUAL \| DEPENDENCY	Required trigger family: `CRON`, `INTERVAL`, `EVENT`, `WEBHOOK`, `MANUAL`, or `DEPENDENCY`.	Enum values are declared in the Type column.
cronExpression	body	No	string	Required for `CRON` schedules; 1-120 characters and used to compute `nextRunAt`.	Minimum length: 1. Maximum length: 120.
intervalMinutes	body	No	integer	Required for `INTERVAL` schedules; 1-525600 minutes.	Minimum value: 1. Maximum value: 525600.
timezone	body	No	string	Timezone used for cron calculations, 1-100 characters; defaults to `America/New_York`.	Minimum length: 1. Maximum length: 100. Default: America/New_York.
blackoutWindows	body	No	object[]	Optional array of blackout-window configuration objects, up to 50 entries.	OpenAPI does not declare additional validation metadata.
eventTrigger	body	No	string	Optional event key for event-triggered schedules, 1-200 characters.	Minimum length: 1. Maximum length: 200.
webhookSecret	body	No	string	Optional caller-provided webhook secret, 16-512 characters. Create/update responses omit it.	Minimum length: 16. Maximum length: 512. Sensitive credential or storage-adjacent value; use placeholders only.
inputParams	body	No	object	Optional runtime parameters supplied to scheduled executions; avoid PHI and raw portal payloads.	OpenAPI does not declare additional validation metadata.
credentialId	body	No	string	Optional automation credential ID owned by the same organization.	Minimum length: 1. Sensitive credential or storage-adjacent value; use placeholders only.
maxConcurrentRuns	body	No	integer	Optional concurrency cap for this schedule, 1-50; defaults to 1.	Minimum value: 1. Maximum value: 50. Default: 1.
retryOnFailure	body	No	boolean	Optional boolean controlling whether failed scheduled runs should retry; defaults to true.	Default: true.
maxRetries	body	No	integer	Optional maximum retry count, 0-10; defaults to 3.	Minimum value: 0. Maximum value: 10. Default: 3.
priority	body	No	HIGH \| NORMAL \| LOW	Optional run priority: `HIGH`, `NORMAL`, or `LOW`; defaults to `NORMAL`.	Enum values are declared in the Type column. Default: NORMAL.
deadlineMinutes	body	No	integer	Optional deadline window for scheduled work, 1-10080 minutes.	Minimum value: 1. Maximum value: 10080.
alertOnFailure	body	No	boolean	Optional boolean controlling failure alerting; defaults to true.	Default: true.
alertEmails	body	No	string (email)[]	Optional alert recipient emails, up to 50 addresses; use operational addresses only.	Default: . Potential PHI; use synthetic examples and avoid logging raw values.
pauseAfterFailures	body	No	integer	Optional consecutive failure threshold, 1-100; defaults to 3.	Minimum value: 1. Maximum value: 100. Default: 3.
dependsOnScheduleId	body	No	string	Optional schedule dependency ID that must belong to the same organization.	Minimum length: 1.
isActive	body	No	boolean	Optional active-state toggle for the schedule; defaults to true.	Default: true.

Generated request example

Generated examples are baseline contract aids only. They are not external publication evidence and must not include real PHI, credentials, raw vendor payloads, raw EDI, transcripts, storage keys, or signed URLs.

{
  "triggerType": "CRON",
  "name": "Example agent_builder_schedule",
  "cronExpression": "example-cronexpression",
  "intervalMinutes": 1,
  "timezone": "America/New_York",
  "blackoutWindows": [
    {}
  ],
  "eventTrigger": "example-eventtrigger",
  "webhookSecret": "example-webhooksecret",
  "inputParams": {}
}

Successful responses

Generated response examples show the baseline OpenAPI contract. Tenant identifier echo, PHI redaction, pagination, money, date/time, and enum semantics remain endpoint-specific publication checks.

201

Agent schedule created for the authenticated organization.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "mode": "SAFE_WRITE_DB_ONLY",
    "schedule": {
      "id": "00000000-0000-4000-8000-000000000001",
      "organizationId": "00000000-0000-4000-8000-000000000001",
      "agentDefinitionId": "00000000-0000-4000-8000-000000000001",
      "name": "Example agent_builder_schedule",
      "triggerType": "CRON",
      "cronExpression": "example-cronexpression",
      "intervalMinutes": 1,
      "timezone": "example-timezone",
      "isActive": true,
      "nextRunAt": "2026-06-08T10:15:30Z",
      "createdAt": "2026-06-08T10:15:30Z",
      "updatedAt": "2026-06-08T10:15:30Z"
    }
  },
  "meta": {
    "organizationId": "00000000-0000-4000-8000-000000000001"
  }
}

Error responses

Errors must remain sanitized. Do not include raw payer, EHR, SFTP, SMTP, Stripe, LLM/OCR, browser automation, file, transcript, EDI, worker, or vendor payloads.

400

Invalid request.