Jobs

Submit a new job

Changed on
post/api/v1/jobs

Request

  • Base URL: http://localhost:8081
  • URL: http://localhost:8081/api/v1/jobs
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Headers

X-Tenant-IDstring required

Tenant isolation header (required on all protected routes).

Idempotency-Keystring uuid

Optional idempotency key for safe retries. Edge event create/batch scopes keys by tenant and endpoint, replays the first response for the same normalized request, and returns 409 idempotency_conflict if the same key is reused with a different normalized request. Callers SHOULD send a UUID (per the original Job submit contract); the Edge runtime additionally accepts any non-empty string up to 512 bytes for backward-compatible local-dev keys.

Request body

promptstring required

The job payload / prompt text

topicstring required

Routing topic for worker dispatch

adapter_idstring

Adapter identifier for the target worker

priority'batch' | 'critical' | 'interactive'

Job scheduling priority

contextobject

Arbitrary context payload for the job

memory_idstring

Memory store identifier for context retrieval

context_modestring

Context retrieval mode (e.g. full, summary)

tenant_idstring

Tenant identifier for multi-tenant isolation

principal_idstring

Principal (user/service) submitting the job

actor_idstring

Actor identifier for audit attribution

actor_typestring

Actor type (human, agent, system)

idempotency_keystring

Client-provided idempotency key to prevent duplicate jobs

pack_idstring

Integration pack identifier

capabilitystring

Required worker capability for dispatch

risk_tagsstring[]

Risk classification tags for policy evaluation

requiresstring[]

Required worker capabilities for dispatch matching

org_idstring

Organization identifier for hierarchical tenancy

team_idstring

Team identifier within the organization

project_idstring

Project identifier for scoped job tracking

labelsobject

Arbitrary key-value labels for filtering and blast radius

max_input_tokensinteger

Maximum input token budget for the job

allow_summarizationboolean

Whether the worker may summarize oversized input

allow_retrievalboolean

Whether the worker may retrieve external context

tagsstring[]

Searchable tags for job discovery

max_output_tokensinteger

Maximum output token budget

max_total_tokensinteger

Maximum total (input + output) token budget

deadline_msinteger

Job deadline in milliseconds from submission (0 = no deadline)

Response

Job accepted

job_idstring
trace_idstring

Changes

  • 12120aad0bfeRevision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 9f66383d6e95Revision changes
    • warning

      for the header request parameter Idempotency-Key, the maxLength was set to 512