public_api
external

Submit Capability Job

post/v1/capabilities/{capability_key}/jobs

Request

  • Base URL: https://api.hydracept.com
  • URL: https://api.hydracept.com/v1/capabilities/{capability_key}/jobs
  • Auth: HTTP bearer

Path parameters

capability_keystring required

Request body

externalRefstring nullable

Opaque caller-owned correlation reference. Never sent to providers. Max 255 characters.

tagsstring[]

Caller-owned flat labels for correlation and future exact-match filtering. At most 32 tags; each tag max 256 characters.

metadataobject

Opaque caller-owned JSON bookkeeping. Never interpreted or sent to providers. Serialized size capped at 16384 UTF-8 bytes.

responseSchemaobject nullable
toolSchemasobject[] nullable
maturityRating'G' | 'PG' | 'PG13' | 'R' | 'NC17'
matureContentTraitsMatureContentTrait[]
maturitySource'explicit_invocation' | 'project_default' | 'workload_derived' | 'legacy_default'
inputobject
inputPayloadRefstring nullable

Verified payload id from POST /v1/payloads. When set, inline input is optional; the server resolves content before admission, estimate, and stream dispatch.

idempotencyKeystring
correlationIdstring nullable
taskKindstring nullable

Response

Successful response

jobIdstring required
capabilityKeystring required
status'queued' | 'running' | 'awaiting_approval' | 'succeeded' | 'failed' | 'canceling' | 'canceled' | 'needs_attention' required
projectIdstring nullable
productIdstring nullable
externalRefstring nullable
tagsstring[]
metadataobject
createdAtstring date-time nullable
completedAtstring date-time nullable
estimatedCostnumber nullable
actualCostnumber nullable

Provider cost when the receipt has evidence for it; null when unknown. Never the customer charge (that is pricing.charge.customerCharge) and never a fabricated 0.

currencystring
receiptIdstring nullable
primaryArtifactIdstring nullable
typedOutputunknown
warningsobject[]
errorobject nullable
requestSnapshotobject nullable

Canonical submitted request for rerunning the same inputs in Studio (not the sealed receipt).

nextActionstring nullable
pollAfterSecondsinteger nullable
retryobject nullable
approvalobject nullable

Sanitized human-gate payload. Present only while the job awaits approval.

Changes

No recorded changes to this operation across all 1 revision of this API.