Create an Agent
POST/agents
Create an agent in the API key's owner scope; an Organization key creates in the issuer's Organization-private workspace. Active creation requests initial processing and, by default, a separate first-check-in timer even when the primary schedule is null. Use is_active=false to prepare a paused agent without initial processing publication or a first-check-in timer; metadata-generation jobs remain. Optional team_id uses current member/destination authority, requires Idempotency-Key and API_CONFIGURATION_ENABLED for fresh creation. template_code applies only on creation; see the Agent API guide for template and schedule precedence. Requires agents:manage.
Request
Responses
- 201
- 400
- 403
- 409
- 429
- 500
- 503
Response Headers
Smaller configured principal/owner request window limit when enforcement is enabled.
Smaller remaining principal/owner allowance at admission.
Seconds until the Redis-server-time fixed request window resets.
Present when Idempotency-Key is used: false for the original response, true for a replay.
Opaque retained receipt ID. Outcome lookup is available for covered G02 member and allowed G01 service operations.
Original protected response expiry.
Server-generated synchronous HTTP correlation; no worker lineage implied.
Invalid request body or query parameters. Field errors may be returned as arrays.
Response Headers
Server-generated synchronous HTTP correlation; no worker lineage implied.
Missing/invalid API key, insufficient scope, account eligibility, or communication policy denial.
Response Headers
Server-generated synchronous HTTP correlation; no worker lineage implied.
Idempotency key reused for a different request, or an incompatible resource state.
Response Headers
Server-generated synchronous HTTP correlation; no worker lineage implied.
request_quota_exceeded or wait_capacity_exceeded. Honor Retry-After; no new input was accepted.
Response Headers
Seconds until the suggested retry, not a readiness guarantee.
Server-generated synchronous HTTP correlation; no worker lineage implied.
Unexpected failure; JSON includes detail and an error_id for support.
Response Headers
Server-generated synchronous HTTP correlation; no worker lineage implied.
configuration_unavailable: New REST configuration admission is disabled; authorized replay survives this gate. admission_unavailable or work_capacity_exceeded. Honor Retry-After and preserve protected-write keys.
Response Headers
Suggested retry seconds when admission coordination is unavailable. configuration_unavailable requires deployment enablement and has no Retry-After interval.
Server-generated synchronous HTTP correlation; no worker lineage implied.